summaryrefslogtreecommitdiffstats
path: root/docs/files/ves7_1spec.rst
blob: fd4c7fd266f195ba223ddc9a3fdb4e5420479871 (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
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property, All rights reserved
.. Copyright 2017-2018 Huawei Technologies Co., Ltd.

===============================
Service: VES Event Listener 7.1
===============================

+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Legal Disclaimer**                                                                                                                                                                                                                                                                                                |
|                                                                                                                                                                                                                                                                                                                     |
| Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at                                                                                                                                            |
|                                                                                                                                                                                                                                                                                                                     |
| http://www.apache.org/licenses/LICENSE-2.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.   |
+=====================================================================================================================================================================================================================================================================================================================+
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


:Document: VES Event Listner
:Revision: 7.1
:Revision Date: December 10th, 2018
:Author: Rich Erickson

+-----------------+-----------------------------+
| Contributors:   | **Min Chen – AT&T**         |
|                 |                             |
|                 | **Fred Delaplace - AT&T**   |
|                 |                             |
|                 | **Andrew Egan – AT&T**      |
|                 |                             |
|                 | **Alok Gupta – AT&T**       |
|                 |                             |
|                 | **Marge Hillis – Nokia**    |
|                 |                             |
|                 | **Gerard Hynes – AT&T**     |
|                 |                             |
|                 | **Ken Kelly – AT&T**        |
|                 |                             |
|                 | **Mark Scott – Ericsson**   |
|                 |                             |
|                 | **Tim Verall – Intel**      |
|                 |                             |
|                 | **Sumit Verdi – VMWare**    |
+-----------------+-----------------------------+

.. contents:: Table of Contents
Introduction
============

This document describes the RESTful interface for the VES Event
Listener. The VES acronym originally stood for Virtual-function Event
Streaming, but VES has been generalized to support network-function
event streaming, whether virtualized or not. The VES Event Listener is
capable of receiving any event sent in the VES Common Event Format. The
Common Event Format is expressed in JSON schema in section 4 of this
document. In the Common Event Format, an event consists of a required
Common Event Header block (i.e., object) accompanied by zero or more
event domain blocks.

It should be understood that events are well structured packages of
information, identified by an eventName, which are asynchronously
communicated to subscribers who are interested in the eventName. Events
can convey measurements, faults, syslogs, threshold crossing alerts and
other types of information. Events are simply a way of communicating
well-structured packages of information to one or more instances of an
Event Listener service.

This document describes a RESTful connectionless push event listener
that is capable of receiving single events or batches of events in the
Common Event Format. In future, additional documents may describe other
transports which make use of persistent TCP connections for high volumes
of streaming events.

Event Registration
------------------

All events must be compliant with the common event format, but specific
events identified by their eventNames, may require that certain fields,
which are optional in the common event format, be present when they are
published. For example, a specific eventName may require that specific
name-value pairs be present in the extensible structures provided within
the Common Event Format.

Events are registered using an extensible YAML format (defined in a
separate document), which specifies, for each eventName, the fields that
are required, what field values may be sent, and any special handling
that should be performed on those eventNames.

Naming Standards for eventName
------------------------------

To prevent naming collisions, eventNames sent as part of the
commonEventHeader, should conform to the following naming convention
designed to summarize the purpose and type of the event, and to ensure
the uniqueness of the eventName:

    {DomainAbbreviation}\_{PublisherName}\_{Description}

Each underscore-separated subfield above must start with a capital
letter and use camel-casing to separate words and acronyms. Acronyms
must capitalize only the first letter of the acronym. Spaces and
underscores should not appear within any subfield.

The DomainAbbreviation subfield derives from the ‘domain’ field in the
commonEventHeader, as specified below:

-  ‘Fault’ for the fault domain

-  ‘Heartbeat’ for the heartbeat domain

-  ‘Measurement’ for the measurement domain

-  ‘MobileFlow’ for the mobileFlow domain

-  ‘Notification’ for the notification domain

-  ‘Other’ for the other domain

-  ‘Perf3gpp’ for the perf3gpp domain

-  ‘PnfReg’ for the pnfRegistration domain

-  ‘SipSignaling’ for the sipSignaling domain

-  ‘StateChange’ for the stateChange domain

-  ‘Syslog’ for the syslog domain

-  ‘Tca’ for the thresholdCrossingAlert domain

-  ‘VoiceQuality’ for the voiceQuality domain

The PublisherName subfield describes the vendor product or application
publishing the event. This subfield conforms to the following
conventions:

-  Vendor products are specified as:

     {productName}-{vendorName}

    For example: Visbc-Metaswitch or Vdbe-Juniper, where a hyphen is
    used to separate the productName and vendorName subfields. Note that
    the productName and vendorName subfields must not include hyphens
    themselves.

    Organizing the information in this way will cause an alphabetical
    listing of eventNames to sort similar network functions together,
    rather than to sort them by vendor.

    The productName subfield may describe a NF or a NFC. Where NFC names
    may be reused across different NF’s, they should be specified as:

     {NfName}:{NfcName}

    where a colon is used to separate the NfName and NfcName subfields.
    Note that the NfName and NfcName subfields must not include colons
    themselves.

    The ProductName may also describe other types of vendor modules or
    components such as a VM, application or hostname. As with NFs and
    NFCs, parent:child relationships may be communicated using colon as
    a subfield delimiter.

-  Service providers who adopt the VES Common Event Format for internal
   use, may provide PublisherName without the vendorName subfield. They
   would typically identify an application, system, service or
   microservice publishing the event (e.g., ‘Policy’, ‘So’,
   ‘MobileCallRecording’ or ‘Dkat’). As with NFs and NFCs, parent:child
   relationships may be communicated using colon as a subfield delimiter
   (e.g., ApplicationName:ApplicationComponent).

The final subfield of the eventName name should describe, in a compact
camel case format the specific information being conveyed by the event.
In some cases, this final subfield may not be required (e.g., in the
case of certain heartbeats).

Examples of eventNames following the naming standards are provided
below:

-  Tca\_Vdbe-Ericsson\_CpuThresholdExceeded

-  Heartbeat\_Visbc:Mmc-Metaswitch

-  Syslog\_Vdbe-Ericsson

-  Fault\_MobileCallRecording\_PilotNumberPoolExhaustion

-  Other\_So:WanBonding\_InstantiationPart1Complete

EventId Use Cases Examples
--------------------------

[Author: Alok Gupta]:

eventId Examples:

Example 1: assumes a unique key for each domain consisting of domain
followed by an integer domainnnnnnn e.g. fault000001, heartbeat000001,
mfvs000005

Example 2: assumes an integer key for all events nnnnnnnnn: 000000001,
00000002, 000000003

Rules:

1. All domains except Fault: each time a subsequent event is sent the
   integer part of eventId will increment by 1. Repeat of eventId
   assumes duplicate event. Sequence number is set to 0 for all domains
   except fault.

2. eventId construction for Fault Events:

   a. Most likely scenario

      i.   The sourceName on each Fault event is the NF Instance Name
           (pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
           identifying this instance of the NF.

      ii.  The eventId on Fault events is the same every time a given
           fault is raised (onset), re-raised at fixed time interval,
           until it is cleared. Once the fault is cleared, a new eventId
           is used.

      iii. The startEpochMicrosec value for the Fault event is the
           timestamp for when that event is generated until a clear is
           sent.

      iv.  lastEpochMicrosec indicates the current event time.

      v.   The sequence number for each Fault event is set to 1 when the
           event is first raised, and increments each time the same
           Fault event is raised, until a clear is sent.

   .. image:: Use-Case-1.png

   b. Alternative scenario: for vNF when fault event status is not
      maintained.

      i.   The sourceName on each Fault event is the NF Instance Name
           (pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
           identifying this instance of the NF.

      ii.  The eventId on Fault events is the same every time a given
           fault is raised or cleared, even if it is re-raised after it
           had previously cleared.  So, for example, if EMS loses
           contact with a particular device then a Fault event might be
           sent for a raise, re-raise (because EMS has re-tried and
           still can’t contact the device), clear (because EMS has
           re-tried and it can contact the device) and then raise again
           (because EMS has lost contact with the device again).  The
           same eventId is used for all 4 of those Fault events.

      iii. The startEpochMicrosec value for each Fault event is the
           timestamp for when that event is generated, not when the
           fault first occurred.  So all 4 of the Fault events in the
           previous bullet point would have a different timestamp.

      iv.  lastEpochMicrosec indicates the current event time.

      v.   The sequence number for each Fault event is currently set to
           0 on a raise and 1 on a clear.  We could change that so that
           each Fault event is given a new monotonically increasing
           sequence number whether it is a raise or a clear if that is
           helpful (which is reset to 0 if the VM restarts) but they
           won’t be consecutive.

   .. image:: Use-Case-2.png

Measurement Expansion Fields
----------------------------

When expansion fields are used, the goal is to avoid custom development
by the service provider collecting the fields, since custom development
adds obvious cost, delay and resource overhead. In the domain of
measurements, it is expected that a high percentage (perhaps as high as
90 percent) of use cases for extensible fields can be satisfied by using
the additionalMeasurements arrayOfNamedHashMap data structure in
combination with a YAML registration file (provided at design time). The
YAML registration file conveys meta-information about the processing of
additionalMeasurements. For more information, please see the VES Event
Registration specification and in particular the aggregationRole, castTo
and isHomogeneous keywords.

Syslogs
-------

Syslog’s can be classified as either Control or Session/Traffic. They
differ by message content and expected volume: 

-  Control logs are generally free-form human-readable text used for
   reporting errors or warnings supporting the operation and
   troubleshooting of NFs.  The volume of these logs is typically less
   than 2k per day.

-  Session logs use common structured fields to report normal NF
   processing such as DNS lookups or firewall rules processed.  The
   volume of these logs is typically greater than 1k per hour (and
   sometimes as high as 10k per second).

VES supports both classes of syslog, however VES is only recommended for
control logs or for lower volume session logs, less than 60k per hour.
High volume session logging should use a file-based transport solution.

Support for Protocols Other Than HTTPS
--------------------------------------

This API specification describes an HTTPS RESTful interface using the
JSON content-type.

Alternative API specifications may be provided in future using Google
Protobuf, websockets, or Apache Avro.

Versioning
----------

Three types of version numbers supported by this specification:

-  The API specification itself is versioned. Going forward, the major
   number of the specification version will be incremented whenever any
   change could break an existing client (e.g., a field name is deleted
   or changed). All other changes to the spec (e.g., a field name is
   added, or text changes are made to the specification itself) will
   increment only the minor number or patch number. Note that the major
   number appears in REST resource URLs as v# (where ‘#’ is the major
   number). Minor and patch numbers are communicated in HTTP headers.
   For more information, see the API Versioning writeup in section 6.1.

-  The JSON schema is versioned. Going forward, the major number of the
   JSON schema will be incremented whenever any change could break an
   existing client (e.g., a field name is deleted or changed). All other
   changes to the schema (e.g., a field name is added or text changes
   are made to the field descriptions) will increment only the minor
   number or patch number.

-  The field blocks are versioned. Field blocks include the
   commonEventHeader and the domain blocks (e.g., the faultFields
   block). Going forward, the major number of each field block will be
   incremented whenever any change to that block could break an existing
   client (e.g., a field name is deleted or changed). All other changes
   to that block (e.g., a field name is added or text changes are made
   to the field descriptions) will increment only the minor number.

Field Block Versions
~~~~~~~~~~~~~~~~~~~~ 

A summary of the latest field block version enums as of this version of
the API spec is provided below:

-  commonEventHeader version 4.1 (note: the enum with support 4.0,
   4.0.1, 4.1 to avoid breaking clients of earlier versions of major
   version 4)

-  commonEventHeader vesEventListenerVersion enum: 7.1 (note: the enum
   will support 7.0, 7.0.1, 7.1 to avoid breaking clients of earlier
   versions of major version 7)

-  faultFieldsVersion:4.0

-  heartbeatFieldsVersion: 3.0

-  measurementFieldsVersion: 4.0

-  mobileFlowFieldsVersion: 4.0

-  notificationFieldsVersion: 2.0

-  otherFieldsVersion: 3.0

-  perf3gppFieldsVersion: 1.0

-  pnfRegistrationFieldsVersion: 2.0

-  sigSignalingFieldsVersion: 3.0

-  stateChangeFieldsVersion: 4.0

-  syslogFieldsVersion: 4.0

-  thresholdCrossingFieldsVersion: 4.0

-  voiceQualityFieldsVersion: 4.0

Security
========

Event sources must identify themselves to the VES Event Listener.

In the future, support for 2-way SSL certificate authentication (aka
mutual SSL) may be provided (see the end of this Security section for
additional information) otherwise, event source credentials must be
passed using HTTP `Basic
Authentication <http://tools.ietf.org/html/rfc2617>`__.

Credentials must not be passed on the query string. Credentials must be
sent in an Authorization header as follows:

1. The username and password are formed into one string as
   “username:password”

2. The resulting string is Base64 encoded to produce the encoded
   credential.

3. The encoded credential is communicated in the header after the string
   “Authorization: Basic “

Because the credentials are merely encoded but not encrypted, HTTPS
(rather than HTTP) should be used. HTTPS will also encrypt and protect
event contents. TLS 1.2 or higher must be used.

Examples are provided below.

Sample Request and Response
---------------------------

Sample Request
~~~~~~~~~~~~~~ 

+-----------------------------------------------------------------+
| POST /eventListener/v7 HTTP/1.1                                 |
|                                                                 |
| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==               |
|                                                                 |
| content-type: application/json                                  |
|                                                                 |
| | content-length: 12345                                         |
| | {                                                             |
|                                                                 |
| "event": {                                                      |
|                                                                 |
| "commonEventHeader": {                                          |
|                                                                 |
| "version": "4.1",                                               |
|                                                                 |
| "vesEventListenerVersion": "7.1",                               |
|                                                                 |
| "domain": "heartbeat",                                          |
|                                                                 |
| "eventName": "Heartbeat\_vIsbcMmc",                             |
|                                                                 |
| "eventId": "heartbeat0000249",                                  |
|                                                                 |
| "sequence": 0,                                                  |
|                                                                 |
| "priority": "Normal",                                           |
|                                                                 |
|  "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",   |
|                                                                 |
| "reportingEntityName": "ibcx0001vm002oam001",                   |
|                                                                 |
| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",             |
|                                                                 |
| "sourceName": "ibcx0001vm002ssc001",                            |
|                                                                 |
| "nfVendorName": "Ericsson",                                     |
|                                                                 |
| "nfNamingCode": "ibcx",                                         |
|                                                                 |
| "nfcNamingCode": "ssc",                                         |
|                                                                 |
| "startEpochMicrosec": 1413378172000000,                         |
|                                                                 |
| "lastEpochMicrosec": 1413378172000000,                          |
|                                                                 |
| "timeZoneOffset": "UTC-05:30"                                   |
|                                                                 |
| }                                                               |
|                                                                 |
| }                                                               |
|                                                                 |
| }                                                               |
+-----------------------------------------------------------------+

Sample Success Response
~~~~~~~~~~~~~~~~~~~~~~~

+--------------------------+
| HTTPS/1.1 202 Accepted   |
|                          |
| X-MinorVersion: 0        |
|                          |
| X-PatchVersion: 0        |
|                          |
| X-LatestVersion: 7.1     |
+--------------------------+

Mutual SSL Certificate Authentication
-------------------------------------

If service provider VES Event Listener support for Mutual SSL
Certification Authentication is available, event sources must initialize
the HTTPS connection with TLS 1.2 or higher and execute mutual
authentication procedures according to
`RFC5246 <https://tools.ietf.org/html/rfc5246#section-7.4.6>`__. If
event source certificates cannot be verified or if certificate subject
(identity) is unknown to the VES Event Listener, then HTTP Basic
Authentication must be used as described above.

Resource Structure
==================

REST resources are defined with respect to a ServerRoot:

ServerRoot = /{optionalRoutingtPath}

The resource structure is provided below:

.. image:: rest-resource.png

Figure – REST Resource Structure

The {Domain} or FQDN above is typically provisioned into each
eventsource when it is instantiated. The {Port} above is typically 8443.

Common Event Format
===================

A JSON schema describing the Common Event Format is provided below and
is reproduced in the tables that follow.

:download:`JSON <CommonEventFormat_30.1_ONAP.json>` 


Note on optional fields:

    If the event publisher collects a field that is identified as
    optional in the data structures below, then the event publisher
    *must* send that field.

Note on extensible fields:

    VES contains various extensible structures (e.g., hashMap) that
    enable event publishers to send information that has not been
    explicitly defined in VES data structures.

-  Event publishers *must not* send information through extensible
   structures where VES has explicitly defined fields for that
   information. For example, event publishers *must not* send
   information like cpuIdle, through an extensible structure, because
   VES has explicitly defined a cpuUsage.cpuIdle field for the
   communication of that information.

-  Keys sent through extensible fields must use camel casing to separate
   words and acronyms; only the first letter of each acronym shall be
   capitalized.

Common Event Datatypes
~~~~~~~~~~~~~~~~~~~~~~

Datatype: arrayOfJsonObject
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The arrayOfJsonObject datatype provides an array of json objects, each
of which is described by name, schema and other meta-information. It
consists of the following fields:

+---------------------+------------------+-------------+-----------------------+
| Field               | Type             | Required?   | Description           |
+=====================+==================+=============+=======================+
| arrayOfJsonObject   | jsonObject [ ]   | Yes         | Array of jsonObject   |
+---------------------+------------------+-------------+-----------------------+

Datatype: arrayOfNamedHashMap
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The arrayOfNamedHashMap datatype provides an array of hashMaps, each of
which is associated with a descriptive name. It consists of the
following fields:

+-----------------------+--------------------+-------------+-------------------------+
| Field                 | Type               | Required?   | Description             |
+=======================+====================+=============+=========================+
| arrayOfNamedHashMap   | namedHashMap [ ]   | Yes         | Array of namedHashMap   |
+-----------------------+--------------------+-------------+-------------------------+

Datatype: event
^^^^^^^^^^^^^^^

The event datatype consists of the following fields which constitute the
‘root level’ of the common event format:

+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| Field                          | Type                           | Required?   | Description                                          |
+================================+================================+=============+======================================================+
| commonEventHeader              | commonEventHeader              | Yes         | Fields common to all events                          |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| faultFields                    | faultFields                    | No          | Fields specific to fault events                      |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| heartbeatFields                | heartbeatFields                | No          | Fields specific to heartbeat events                  |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| measurementFields              | measurementFields              | No          | Fields specific to measurement events                |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| mobileFlowFields               | mobileFlowFields               | No          | Fields specific to mobility flow events              |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| notificationFields             | notificationFields             | No          | Fields specific to notification events               |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| otherFields                    | otherFields                    | No          | Fields specific to other types of events             |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| pnfRegistrationFields          | pnfRegistrationFields          | No          | Fields specific to pnfRegistration events            |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| sipSignalingFields             | sipSignalingFields             | No          | Fields specific to sipSignaling events               |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| stateChangeFields              | stateChangeFields              | No          | Fields specific to state change events               |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| syslogFields                   | syslogFields                   | No          | Fields specific to syslog events                     |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| thresholdCrossingAlertFields   | thresholdCrossingAlertFields   | No          | Fields specific to threshold crossing alert events   |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
| voiceQualityFields             | voiceQualityFields             | No          | Fields specific to voiceQuality events               |
+--------------------------------+--------------------------------+-------------+------------------------------------------------------+

Datatype: eventList
^^^^^^^^^^^^^^^^^^^

The eventList datatype consists of the following fields:

+-------------+-------------+-------------+-------------------+
| Field       | Type        | Required?   | Description       |
+=============+=============+=============+===================+
| eventList   | event [ ]   | Yes         | Array of events   |
+-------------+-------------+-------------+-------------------+

Datatype: hashMap
^^^^^^^^^^^^^^^^^

The hashMap datatype is an ‘associative array’, which is an unordered
collection of key-value pairs of the form “key”: “value”, where each key
and value are strings. Keys must use camel casing to separate words and
acronyms; only the first letter of each acronym shall be capitalized.

Datatype: jsonObject
^^^^^^^^^^^^^^^^^^^^

The jsonObject datatype provides a json object schema, name and other
meta-information along with one or more object instances that conform to
the schema:

+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                    | Type                     | Required?   | Description                                                                                                                                                               |
+==========================+==========================+=============+===========================================================================================================================================================================+
| objectInstances          | JsonObjectInstance [ ]   | Yes         | Contains one or more instances of the json object                                                                                                                         |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| objectName               | string                   | Yes         | Name of the json object                                                                                                                                                   |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| objectSchema             | string                   | No          | json schema for the object                                                                                                                                                |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| objectSchemaUrl          | string                   | No          | URL to the json schema for the object                                                                                                                                     |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nfSubscribedObjectName   | string                   | No          | Name of the object associated with the nfSubscriptionId                                                                                                                   |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nfSubscriptionId         | string                   | No          | Identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject   |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: jsonObjectInstance
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The jsonObjectInstance datatype provides meta-information about an
instance of a jsonObject along with the actual object instance:

+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Field                         | Type         | Required?   | Description                                                                                                                               |
+===============================+==============+=============+===========================================================================================================================================+
| jsonObject                    | jsonObject   | No          | Optional recursive specification of jsonObject                                                                                            |
+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| objectInstance                | object       | No          | Contains an instance conforming to the jsonObject schema                                                                                  |
+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| objectInstanceEpochMicrosec   | number       | No          | the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds   |
+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| objectKeys                    | key [ ]      | No          | An ordered set of keys that identifies this particular instance of jsonObject (e.g., that places it in a hierarchy)                       |
+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: key
^^^^^^^^^^^^^

The key datatype is a tuple which provides the name of a key along with
its value and relative order; it consists of the following fields:

+------------+-----------+-------------+----------------------------------------------------------------------+
| Field      | Type      | Required?   | Description                                                          |
+============+===========+=============+======================================================================+
| keyName    | string    | Yes         | Name of the key                                                      |
+------------+-----------+-------------+----------------------------------------------------------------------+
| keyOrder   | Integer   | No          | Relative sequence or order of the key (with respect to other keys)   |
+------------+-----------+-------------+----------------------------------------------------------------------+
| keyValue   | string    | No          | Value of the key                                                     |
+------------+-----------+-------------+----------------------------------------------------------------------+

Datatype: namedHashMap
^^^^^^^^^^^^^^^^^^^^^^

The namedHashMap datatype is a hashMap which is associated with and
described by a name; it consists of the following fields:

+-----------+-----------+-------------+--------------------------------------------------+
| Field     | Type      | Required?   | Description                                      |
+===========+===========+=============+==================================================+
| name      | string    | Yes         | Name associated with or describing the hashmap   |
+-----------+-----------+-------------+--------------------------------------------------+
| hashMap   | hashMap   | Yes         | One or more key:value pairs                      |
+-----------+-----------+-------------+--------------------------------------------------+

Datatype: requestError
^^^^^^^^^^^^^^^^^^^^^^

The requestError datatype defines the standard request error data
structure:

+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field       | Type     | Required?   | Description                                                                                                                                                                                                                                                                                    |
+=============+==========+=============+================================================================================================================================================================================================================================================================================================+
| messageId   | string   | Yes         | Unique message identifier of the format ‘ABCnnnn’ where ‘ABC’ is either ‘SVC’ for Service Exceptions or ‘POL’ for Policy Exception. Exception numbers may be in the range of 0001 to 9999 where 0001 to 2999 are defined by OMA (see section 5.1) and 3000-9999 are available and undefined.   |
+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text        | string   | Yes         | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1                                                                                                                                                              |
+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| url         | string   | No          | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents                                                                                                                                                                                                              |
+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| variables   | string   | No          | List of zero or more strings that represent the contents of the variables used by the message text                                                                                                                                                                                             |
+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: vendorNfNameFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The vendorNfNameFields provides vendor, nf and nfModule identifying
information:

+----------------+----------+-------------+-----------------------------------------------------+
| Field          | Type     | Required?   | Description                                         |
+================+==========+=============+=====================================================+
| vendorName     | string   | Yes         | Network function vendor name                        |
+----------------+----------+-------------+-----------------------------------------------------+
| nfModuleName   | string   | No          | Name of the nfModule generating the event           |
+----------------+----------+-------------+-----------------------------------------------------+
| nfName         | string   | No          | Name of the network function generating the event   |
+----------------+----------+-------------+-----------------------------------------------------+

‘Common Event Header’ Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: commonEventHeader
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The commonEventHeader datatype consists of the following fields common
to all events:

+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                     | Type                    | Required?   | |
+===========================+=========================+=============+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| domain                    | string                  | Yes         | Event domain enumeration: ‘fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘perf3gpp’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventId                   | string                  | Yes         | Event key that is unique to the event source. The key must be unique within notification life cycle similar to EventID from 3GPP. It could be a sequential number, or a composite key formed from the event fields, such as domain\_sequence. The eventId should not include whitespace. For fault events, eventId is the eventId of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, eventId must be the same as the initial alarm (along with the same startEpochMicrosec but with a different sequence number). Note: see section 1.3 for eventId use case examples.                                                                                                                                                                                                                        |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventName                 | string                  | Yes         | |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventType                 | string                  | No          | |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| internalHeader Fields     | internalHeader Fields   | No          | Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each service provider (e.g., AT&T) implementing the VES Event Listener.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lastEpochMicrosec         | number                  | Yes         | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nfcNamingCode             | string                  | No          | Network function component type: 3 characters (aligned with vfc naming standards)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nfNamingCode              | string                  | No          | Network function type: 4 characters (aligned with vnf and pnf naming standards)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nfVendorName              | string                  | No          | |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| priority                  | string                  | Yes         | |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| reportingEntityId         | string                  | No          | UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| reportingEntityName       | string                  | Yes         | Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sequence                  | integer                 | Yes         | Ordering of events communicated by an event source instance (or 0 if not needed)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sourceId                  | string                  | No          | UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sourceName                | string                  | Yes         | Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNF (vnf or pnf), xNFC or VM, then the event must be reporting data for that particular xNF, xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event.                                                                                                                                                                                                                                                                                   |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| startEpochMicrosec        | number                  | Yes         | the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received)   |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| timeZoneOffset            | string                  | No          | Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| version                   | string                  | Yes         | Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vesEventListenerVersion   | string                  | Yes         | Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: internalHeaderFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The internalHeaderFields datatype is an undefined object which can
contain arbitrarily complex JSON structures. It is intended to be
defined separately by each service provider (e.g., AT&T) implementing
the VES Event Listener. The fields in internalHeaderFields are not
provided by any event source but instead are added by the VES Event
Listener service itself as part of an event enrichment process necessary
for efficient internal processing of events received by the VES Event
Listener.

Technology Independent Datatypes
--------------------------------

‘Fault’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: faultFields
^^^^^^^^^^^^^^^^^^^^^

The faultFields datatype consists of the following fields:

+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                         | Type      | Required?   | Description                                                                                                                                                                        |
+===============================+===========+=============+====================================================================================================================================================================================+
| alarmAdditional Information   | hashMap   | No          | Additional alarm information.                                                                                                                                                      |
|                               |           |             |                                                                                                                                                                                    |
|                               |           |             | -  Note1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind).                                                                 |
|                               |           |             |                                                                                                                                                                                    |
|                               |           |             | -  Note2: Alarm ID for 3GPP should be included (if applicable) in alarmAdditonalInformation as ‘alarmId’:’alarmIdValue’.                                                           |
|                               |           |             |                                                                                                                                                                                    |
|                               |           |             | Could contain managed object instance as separate key:value; could add probable cause as separate key:value.                                                                       |
+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| alarmCondition                | string    | Yes         | Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…)                             |
+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| alarmInterfaceA               | string    | No          | Card, port, channel or interface name of the device generating the alarm. This could reflect managed object.                                                                       |
+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventCategory                 | string    | No          | Event category, for example: ‘license’, ‘link’, ‘routing’, ‘security’, ‘signaling’                                                                                                 |
+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventSeverity                 | string    | Yes         | Event severity enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’. NORMAL is used to represent clear.                                                                  |
+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventSourceType               | string    | Yes         | Examples: ‘card’, ‘host’, ‘other’, ‘port’, ‘portThreshold’, ‘router’, ‘slotThreshold’, ‘switch’, ‘virtualMachine’, ‘virtualNetworkFunction’. This could be managed object class.   |
+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| faultFieldsVersion            | string    | Yes         | Version of the faultFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.                                                                         |
+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| specificProblem               | string    | Yes         | Description of the alarm or problem (e.g., ‘eNodeB 155197 in PLMN 310-410 with eNodeB name KYL05197 is lost’). 3GPP probable cause would be included in this field.                |
+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vfStatus                      | string    | Yes         | Virtual function status enumeration: ‘Active’, ‘Idle’, ‘Preparing to terminate’, ‘Ready to terminate’, ‘Requesting Termination’                                                    |
+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Heartbeat’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: heartbeatFields
^^^^^^^^^^^^^^^^^^^^^^^^^

The heartbeatFields datatype is an optional field block for fields
specific to heartbeat events; it consists of the following fields:

+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+
| Field                    | Type      | Required?   | Description                                                                                                      |
+==========================+===========+=============+==================================================================================================================+
| additionalFields         | hashMap   | No          | Additional expansion fields if needed                                                                            |
+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+
| heartbeatFieldsVersion   | string    | Yes         | Version of the heartbeatFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.   |
+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+
| heartbeatInterval        | Integer   | Yes         | Current heartbeatInterval in seconds                                                                             |
+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+

‘Measurements’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Note: NFs are required to report exactly one Measurement event per
period per sourceName.

Datatype: codecsInUse
^^^^^^^^^^^^^^^^^^^^^

The codecsInUse datatype consists of the following fields describing the
number of times an identified codec was used over the
measurementInterval:

+------------------+-----------+-------------+--------------------------------+
| Field            | Type      | Required?   | Description                    |
+==================+===========+=============+================================+
| codecIdentifer   | string    | Yes         | Description of the codec       |
+------------------+-----------+-------------+--------------------------------+
| numberInUse      | integer   | Yes         | Number of such codecs in use   |
+------------------+-----------+-------------+--------------------------------+

Datatype: cpuUsage
^^^^^^^^^^^^^^^^^^

The cpuUsage datatype defines the usage of an identifier CPU and
consists of the following fields:

+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Field                   | Type     | Required?   | Description                                                                                                                         |
+=========================+==========+=============+=====================================================================================================================================+
| cpuCapacityContention   | number   | No          | The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval                               |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuDemandAvg            | number   | No          | The total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval            |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuDemandMhz            | number   | No          | CPU demand in MHz                                                                                                                   |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuDemandPct            | number   | No          | CPU demand as a percentage of the provisioned capacity                                                                              |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuIdentifier           | string   | Yes         | CPU Identifier                                                                                                                      |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuIdle                 | number   | No          | Percentage of CPU time spent in the idle task                                                                                       |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuLatencyAvg           | number   | No          | Percentage of time the VM is unable to run because it is contending for access to the physical CPUs                                 |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuOverheadAvg          | number   | No          | The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval                      |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuSwapWaitTime         | number   | No          | Swap wait time, in milliseconds over the measurementInterval                                                                        |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageInterrupt       | number   | No          | Percentage of time spent servicing interrupts                                                                                       |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageNice            | number   | No          | Percentage of time spent running user space processes that have been niced                                                          |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageSoftIrq         | number   | No          | Percentage of time spent handling soft irq interrupts                                                                               |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageSteal           | number   | No          | Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing   |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageSystem          | number   | No          | Percentage of time spent on system tasks running the kernel                                                                         |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageUser            | number   | No          | Percentage of time spent running un-niced user space processes                                                                      |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuWait                 | number   | No          | Percentage of CPU time spent waiting for I/O operations to complete                                                                 |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| percentUsage            | number   | Yes         | Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running                                         |
+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+

Datatype: diskUsage
^^^^^^^^^^^^^^^^^^^

The diskUsage datatype defines the usage of a disk and consists of the
following fields:

+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                       | Type     | Required?   | Description                                                                                                                                                                                                                   |
+=============================+==========+=============+===============================================================================================================================================================================================================================+
| diskBusResets               | number   | No          | Number of bus resets over the measurementInterval                                                                                                                                                                             |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskCommandsAborted         | number   | No          | Number of disk commands aborted over the measurementInterval                                                                                                                                                                  |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskCommandsAvg             | number   | No          | Average number of commands per second over the measurementInterval                                                                                                                                                            |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskFlushRequests           | number   | No          | Total flush requests of the disk cache over the measurementInterval                                                                                                                                                           |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskFlushTime               | number   | No          | Milliseconds spent on disk cache flushing over the measurementInterval                                                                                                                                                        |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskIdentifier              | string   | Yes         | Disk Identifier                                                                                                                                                                                                               |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskIoTimeAvg               | number   | No          | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval                                  |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskIoTimeLast              | number   | No          | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval                 |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskIoTimeMax               | number   | No          | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskIoTimeMin               | number   | No          | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedReadAvg           | number   | No          | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval            |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedReadLast          | number   | No          | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval         |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedReadMax           | number   | No          | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedReadMin           | number   | No          | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedWriteAvg          | number   | No          | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval         |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedWriteLast         | number   | No          | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedWriteMax          | number   | No          | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedWriteMin          | number   | No          | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsRead Avg          | number   | No          | Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval                                                                                                    |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsRead              | number   | No          | Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval                                                                                                       |
|                             |          |             |                                                                                                                                                                                                                               |
| Last                        |          |             |                                                                                                                                                                                                                               |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsRead Max          | number   | No          | Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval                                                                                                    |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsRead Min          | number   | No          | Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval                                                                                                    |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsWrite Avg         | number   | No          | Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval                                                                                                   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsWrite Last        | number   | No          | Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval                                                                                                      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsWriteMax          | number   | No          | Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval                                                                                                   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsWriteMin          | number   | No          | Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval                                                                                                   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsReadAvg              | number   | No          | Number of read operations per second issued to the disk; provide the average measurement within the measurement interval                                                                                                      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsReadLast             | number   | No          | Number of read operations per second issued to the disk; provide the last measurement within the measurement interval                                                                                                         |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsReadMax              | number   | No          | Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval                                                                                                      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsReadMin              | number   | No          | Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval                                                                                                      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsWriteAvg             | number   | No          | Number of write operations per second issued to the disk; provide the average measurement within the measurement interval                                                                                                     |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsWriteLast            | number   | No          | Number of write operations per second issued to the disk; provide the last measurement within the measurement interval                                                                                                        |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsWrite Max            | number   | No          | Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval                                                                                                     |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsWriteMin             | number   | No          | Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval                                                                                                     |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskPendingOperationsAvg    | number   | No          | Queue size of pending I/O operations per second; provide the average measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskPendingOperationsLast   | number   | No          | Queue size of pending I/O operations per second; provide the last measurement within the measurement interval                                                                                                                 |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskPendingOperationsMax    | number   | No          | Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskPendingOperationsMin    | number   | No          | Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskReadCommandsAvg         | number   | No          | Average number of read commands issued per second to the disk over the measurementInterval                                                                                                                                    |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTime                    | number   | No          | Nanoseconds spent on disk cache reads/writes within the measurement interval                                                                                                                                                  |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeReadAvg             | number   | No          | Milliseconds a read operation took to complete; provide the average measurement within the measurement interval                                                                                                               |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeRead Last           | number   | No          | Milliseconds a read operation took to complete; provide the last measurement within the measurement interval                                                                                                                  |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeRead Max            | number   | No          | Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval                                                                                                               |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeRead Min            | number   | No          | Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval                                                                                                               |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeWrite Avg           | number   | No          | Milliseconds a write operation took to complete; provide the average measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeWrite Last          | number   | No          | Milliseconds a write operation took to complete; provide the last measurement within the measurement interval                                                                                                                 |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeWrite Max           | number   | No          | Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeWrite Min           | number   | No          | Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTotalReadLatencyAvg     | number   | No          | Average read time from the perspective of a Guest OS: sum of the Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval                                                           |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTotalWriteLatencyAvg    | number   | No          | Average write time from the perspective of a Guest OS: sum of the Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval                                                        |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskWeightedIoTimeAvg       | number   | No          | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the average within the collection interval.                                                                           |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskWeightedIoTimeLast      | number   | No          | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the last within the collection interval.                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskWeightedIoTimeMax       | number   | No          | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the maximum within the collection interval.                                                                           |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskWeightedIoTimeMin       | number   | No          | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the minimum within the collection interval.                                                                           |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskWriteCommandsAvg        | number   | No          | Average number of write commands issued per second to the disk over the measurementInterval                                                                                                                                   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: filesystemUsage
^^^^^^^^^^^^^^^^^^^^^^^^^

The filesystemUsage datatype consists of the following fields:

+-----------------------+----------+-------------+--------------------------------------------------------+
| Field                 | Type     | Required?   | Description                                            |
+=======================+==========+=============+========================================================+
| filesystemName        | string   | Yes         | File system name                                       |
+-----------------------+----------+-------------+--------------------------------------------------------+
| blockConfigured       | number   | Yes         | Configured block storage capacity in GB                |
+-----------------------+----------+-------------+--------------------------------------------------------+
| blockIops             | number   | Yes         | Block storage input-output operations per second       |
+-----------------------+----------+-------------+--------------------------------------------------------+
| blockUsed             | number   | Yes         | Used block storage capacity in GB                      |
+-----------------------+----------+-------------+--------------------------------------------------------+
| ephemeralConfigured   | number   | Yes         | Configured ephemeral storage capacity in GB            |
+-----------------------+----------+-------------+--------------------------------------------------------+
| ephemeralIops         | number   | Yes         | Ephemeral storage input-output operations per second   |
+-----------------------+----------+-------------+--------------------------------------------------------+
| ephemeralUsed         | number   | Yes         | Used ephemeral storage capacity in GB                  |
+-----------------------+----------+-------------+--------------------------------------------------------+

Datatype: hugePages
^^^^^^^^^^^^^^^^^^^

The hugePages datatype provides metrics on system hugePages; it consists
of the following fields:

+-----------------------+----------+-------------+---------------------------------------+
| Field                 | Type     | Required?   | Description                           |
+=======================+==========+=============+=======================================+
| bytesFree             | number   | No          | Number of free hugePages in bytes     |
+-----------------------+----------+-------------+---------------------------------------+
| bytesUsed             | number   | No          | Number of used hugePages in bytes     |
+-----------------------+----------+-------------+---------------------------------------+
| hugePagesIdentifier   | string   | Yes         | HugePages identifier                  |
+-----------------------+----------+-------------+---------------------------------------+
| percentFree           | number   | No          | Number of free hugePages in percent   |
+-----------------------+----------+-------------+---------------------------------------+
| percentUsed           | number   | No          | Number of used hugePages in percent   |
+-----------------------+----------+-------------+---------------------------------------+
| vmPageNumberFree      | number   | No          | Number of free vmPages in numbers     |
+-----------------------+----------+-------------+---------------------------------------+
| vmPageNumberUsed      | number   | No          | Number of used vmPages in numbers     |
+-----------------------+----------+-------------+---------------------------------------+

Datatype: ipmi (Intelligent Platform Management Interface)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ipmi datatype provides intelligent platform management interface
metrics; it consists of the following fields:

+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| Field                                 | Type                                 | Required?   | Description                                       |
+=======================================+======================================+=============+===================================================+
| exitAirTemperature                    | number                               | No          | System fan exit air flow temperature in Celsius   |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| frontPanelTemperature                 | number                               | No          | Front panel temp in Celsius                       |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| ioModuleTemperature                   | number                               | No          | Io module temp in Celsius                         |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| ipmiBaseboardTemperatureArray         | ipmiBaseboard Temperature [ ]        | No          | Array of ipmiBaseboard Temperature objects        |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| ipmiBaseboardVoltageRegulator Array   | ipmiBaseboard VoltageRegulator [ ]   | No          | Array of ipmiBaseboard VoltageRegulator objects   |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| ipmiBatteryArray                      | ipmiBattery [ ]                      | No          | Array of ipmiBattery objects                      |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| ipmiFanArray                          | ipmiFan [ ]                          | No          | Array of ipmiFan objects                          |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| ipmiGlobalAggregateTemperature        | ipmiGlobalAggregate                  | No          | ipmi global aggregate temperature margin          |
|                                       |                                      |             |                                                   |
| MarginArray                           | TemperatureMargin [ ]                |             |                                                   |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| ipmiHsbpArray                         | ipmiHsbp [ ]                         | No          | Array of ipmiHsbp objects                         |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| ipmiNicArray                          | ipmiNic [ ]                          | No          | Array of ipmiNic objects                          |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| ipmiPowerSupplyArray                  | ipmiPowerSupply [ ]                  | No          | Array of ipmiPowerSupply objects                  |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| ipmiProcessorArray                    | ipmiProcessor [ ]                    | No          | Array of ipmiProcessor objects                    |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
| systemAirflow                         | number                               | No          | Airflow in cubic feet per minute (cfm)            |
+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+

Datatype: ipmiBaseboardTemperature
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ipmiBaseboardTemperature datatype consists of the following fields
which describe ipmi baseboard temperature metrics:

+-----------------------------------+----------+-------------+--------------------------------------------------------------+
| Field                             | Type     | Required?   | Description                                                  |
+===================================+==========+=============+==============================================================+
| baseboardTemperature              | number   | No          | Baseboard temperature in celsius                             |
+-----------------------------------+----------+-------------+--------------------------------------------------------------+
| baseboardTemperature Identifier   | string   | Yes         | Identifier for the location where the temperature is taken   |
+-----------------------------------+----------+-------------+--------------------------------------------------------------+

Datatype: ipmiBaseboardVoltageRegulator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ipmiBaseboardVoltageRegulator datatype consists of the following
fields which describe ipmi baseboard voltage regulator metrics:

+----------------------------------------+----------+-------------+--------------------------------------------------+
| Field                                  | Type     | Required?   | Description                                      |
+========================================+==========+=============+==================================================+
| baseboardVoltage RegulatorIdentifier   | string   | Yes         | Identifier for the baseboard voltage regulator   |
+----------------------------------------+----------+-------------+--------------------------------------------------+
| voltageRegulator Temperature           | number   | No          | Voltage regulator temperature in celsius         |
+----------------------------------------+----------+-------------+--------------------------------------------------+

Datatype: ipmiBattery
^^^^^^^^^^^^^^^^^^^^^

The ipmiBattery datatype consists of the following fields which describe
ipmi battery metrics:

+-----------------------+----------+-------------+------------------------------+
| Field                 | Type     | Required?   | Description                  |
+=======================+==========+=============+==============================+
| batteryIdentifier     | string   | Yes         | Identifier for the battery   |
+-----------------------+----------+-------------+------------------------------+
| batteryType           | string   | No          | Type of battery              |
+-----------------------+----------+-------------+------------------------------+
| batteryVoltageLevel   | number   | No          | Battery voltage level        |
+-----------------------+----------+-------------+------------------------------+

Datatype: ipmiFan
^^^^^^^^^^^^^^^^^

The ipmiFan datatype consists of the following fields which describe
ipmi fan metrics:

+-----------------+----------+-------------+---------------------------------------------+
| Field           | Type     | Required?   | Description                                 |
+=================+==========+=============+=============================================+
| fanIdentifier   | string   | Yes         | Identifier for the fan                      |
+-----------------+----------+-------------+---------------------------------------------+
| fanSpeed        | number   | No          | Fan speed in revolutions per minute (rpm)   |
+-----------------+----------+-------------+---------------------------------------------+

Datatype: ipmiGlobalAggregateTemperatureMargin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ipmiGlobalAggregateTemperatureMargin datatype consists of the
following fields:

+----------------------------------------------+----------+-------------+-----------------------------------------------------------------------------+
| Field                                        | Type     | Required?   | Description                                                                 |
+==============================================+==========+=============+=============================================================================+
| globalAggregateTemperatureMargin             | number   | No          | Temperature margin in Celsius relative to a throttling thermal trip point   |
+----------------------------------------------+----------+-------------+-----------------------------------------------------------------------------+
| globalAggregateTemperatureMarginIdentifier   | string   | Yes         | Identifier for the ipmi global aggregate temperature margin metrics         |
+----------------------------------------------+----------+-------------+-----------------------------------------------------------------------------+

Datatype: ipmiHsbp
^^^^^^^^^^^^^^^^^^

The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it
consists of the following fields:

+-------------------+----------+-------------+----------------------------------------------------+
| Field             | Type     | Required?   | Description                                        |
+===================+==========+=============+====================================================+
| hsbpIdentifier    | string   | Yes         | Identifier for the hot swap backplane power unit   |
+-------------------+----------+-------------+----------------------------------------------------+
| hsbpTemperature   | number   | No          | Hot swap backplane power temperature in celsius    |
+-------------------+----------+-------------+----------------------------------------------------+

Datatype: ipmiNic
^^^^^^^^^^^^^^^^^

The ipmiNic datatype provides network interface control care metrics; it
consists of the following fields:

+------------------+----------+-------------+-----------------------------------------------------+
| Field            | Type     | Required?   | Description                                         |
+==================+==========+=============+=====================================================+
| nicIdentifier    | string   | Yes         | Identifier for the network interface control card   |
+------------------+----------+-------------+-----------------------------------------------------+
| nicTemperature   | number   | No          | nic temperature in Celsius                          |
+------------------+----------+-------------+-----------------------------------------------------+

Datatype: ipmiPowerSupply
^^^^^^^^^^^^^^^^^^^^^^^^^

The ipmiPowerSupply datatype provides ipmi power supply metrics; it
consists of the following fields:

+------------------------------------+----------+-------------+------------------------------------------------------------------------+
| Field                              | Type     | Required?   | Description                                                            |
+====================================+==========+=============+========================================================================+
| powerSupplyCurrentOutput Percent   | number   | No          | Current output voltage as a percentage of the design specified level   |
+------------------------------------+----------+-------------+------------------------------------------------------------------------+
| powerSupplyIdentifier              | string   | Yes         | Identifier for the power supply                                        |
+------------------------------------+----------+-------------+------------------------------------------------------------------------+
| powerSupplyInputPower              | number   | No          | Input power in watts                                                   |
+------------------------------------+----------+-------------+------------------------------------------------------------------------+
| powerSupplyTemperature             | number   | No          | Power supply temperature in Celsius                                    |
+------------------------------------+----------+-------------+------------------------------------------------------------------------+

Datatype: ipmiProcessor
^^^^^^^^^^^^^^^^^^^^^^^

The ipmiProcessor datatype provides ipmi processor metrics; it consists
of the following fields:

+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+
| Field                                       | Type                                        | Required?   | Description                                             |
+=============================================+=============================================+=============+=========================================================+
| processorDimmAggregate ThermalMarginArray   | processorDimm AggregateThermal Margin [ ]   | No          | Array of processorDimmAggregate ThermalMargin objects   |
+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+
| processorDtsThermalMargin                   | number                                      | No          | Front panel temperature in celsius                      |
+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+
| processorIdentifier                         | string                                      | Yes         | Identifier for the power supply                         |
+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+
| processorThermalControl Percent             | number                                      | No          | Io module temperatue in celsius                         |
+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+

Datatype: latencyBucketMeasure
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The latencyBucketMeasure datatype consists of the following fields which
describe the number of counts falling within a defined latency bucket:

+--------------------------+----------+-------------+------------------------------------------------------------+
| Field                    | Type     | Required?   | Description                                                |
+==========================+==========+=============+============================================================+
| countsInTheBucket        | number   | Yes         | Number of counts falling within a defined latency bucket   |
+--------------------------+----------+-------------+------------------------------------------------------------+
| highEndOfLatencyBucket   | number   | No          | High end of bucket range (typically in ms)                 |
+--------------------------+----------+-------------+------------------------------------------------------------+
| lowEndOfLatencyBucket    | number   | No          | Low end of bucket range (typically in ms)                  |
+--------------------------+----------+-------------+------------------------------------------------------------+

Datatype: load
^^^^^^^^^^^^^^

The load datatype provides metrics on system cpu and io utilization
obtained using /proc/loadavg; it consists of the following fields:

+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field       | Type     | Required?   | Description                                                                                                                                                 |
+=============+==========+=============+=============================================================================================================================================================+
| longTerm    | number   | No          | number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg   |
+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| midTerm     | number   | No          | number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg    |
+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| shortTerm   | number   | No          | number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg     |
+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: machineCheckException
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The machineCheckException datatype describes machine check exceptions;
it consists of the following fields:

+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                           | Type     | Required?   | Description                                                                                                                                                                                                                                                       |
+=================================+==========+=============+===================================================================================================================================================================================================================================================================+
| correctedMemoryErrors           | number   | No          | Total hardware errors that were corrected by the hardware (e.g. data corruption corrected via  ECC) over the measurementInterval. These errors do not require immediate software actions, but are still reported for accounting and predictive failure analysis   |
+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| correctedMemoryErrors In1Hr     | number   | No          | Total hardware errors that were corrected by the hardware over the last one hour                                                                                                                                                                                  |
+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| uncorrectedMemoryErrors         | number   | No          | Total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval. These errors require a software response.                                                                                      |
+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| uncorrectedMemoryErrors In1Hr   | number   | No          | Total uncorrected hardware errors that were detected by the hardware over the last one hour                                                                                                                                                                       |
+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vmIdentifier                    | string   | Yes         | Virtual machine identifier associated with the machine check exception                                                                                                                                                                                            |
+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: measurementFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The measurementFields datatype consists of the following fields:

+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                        | Type                        | Required?   | Description                                                                                                                                                                                               |
+==============================+=============================+=============+===========================================================================================================================================================================================================+
| additionalFields             | hashMap                     | No          | Additional measurement fields if needed                                                                                                                                                                   |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| additionalMeasurements       | arrayOfNamedHashMap         | No          | Array of named hashMap if needed                                                                                                                                                                          |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| additionalObjects            | arrayOfJsonObject           | No          | Array of JSON objects described by name, schema and other meta-information, if needed                                                                                                                     |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| codecUsageArray              | codecsInUse []              | No          | Array of codecs in use                                                                                                                                                                                    |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| concurrentSessions           | integer                     | No          | Peak concurrent sessions for the VM or xNF (depending on the context) over the measurementInterval                                                                                                        |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| configuredEntities           | integer                     | No          | Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the xNF   |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageArray                | cpuUsage []                 | No          | Usage of an array of CPUs                                                                                                                                                                                 |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskUsageArray               | diskUsage []                | No          | Usage of an array of disks                                                                                                                                                                                |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| featureUsageArray            | hashMap                     | No          | The hashMap key should identify the feature, while the value defines the number of times the identified feature was used                                                                                  |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| filesystemUsageArray         | filesystemUsage [ ]         | No          | Filesystem usage of the VM on which the xNFC reporting the event is running                                                                                                                               |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| hugePagesArray               | hugePages [ ]               | No          | Array of metrics on hugePages                                                                                                                                                                             |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipmi                         | ipmi                        | No          | Intelligent platform management interface metrics                                                                                                                                                         |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| latencyDistribution          | latencyBucketMeasure [ ]    | No          | Array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges; where latency is the duration between a service request and its fulfillment.      |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| loadArray                    | load [ ]                    | No          | Array of system load metrics                                                                                                                                                                              |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| machineCheckExceptionArray   | machineCheckException [ ]   | No          | Array of machine check exceptions                                                                                                                                                                         |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| meanRequestLatency           | number                      | No          | Mean seconds required to respond to each request for the VM on which the xNFC reporting the event is running                                                                                              |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| measurementFieldsVersion     | string                      | Yes         | Version of the measurementFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.                                                                                          |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| measurementInterval          | number                      | Yes         | Interval over which measurements are being reported in seconds                                                                                                                                            |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| memoryUsageArray             | memoryUsage []              | No          | Memory usage of an array of VMs                                                                                                                                                                           |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nfcScalingMetric             | integer                     | No          | Represents busy-ness of the network function from 0 to 100 as reported by the nfc                                                                                                                         |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nicPerformanceArray          | nicPerformance [ ]          | No          | Performance metrics of an array of network interface cards                                                                                                                                                |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numberOfMediaPortsInUse      | integer                     | No          | Number of media ports in use                                                                                                                                                                              |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| processStatsArray            | processStats [ ]            | No          | Array of metrics on system processes                                                                                                                                                                      |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| requestRate                  | number                      | No          | Peak rate of service requests per second to the xNF over the measurementInterval                                                                                                                          |
+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: memoryUsage
^^^^^^^^^^^^^^^^^^^^^

The memoryUsage datatype defines the memory usage of a virtual machine
and consists of the following fields:

+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| Field                  | Type     | Required?   | Description                                                                                                                       |
+========================+==========+=============+===================================================================================================================================+
| memoryBuffered         | number   | No          | Kibibytes of temporary storage for raw disk blocks                                                                                |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memoryCached           | number   | No          | Kibibytes of memory used for cache                                                                                                |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memoryConfigured       | number   | No          | Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running                            |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memoryDemand           | number   | No          | Host demand in kibibytes                                                                                                          |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memoryFree             | number   | Yes         | Kibibytes of physical RAM left unused by the system                                                                               |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memoryLatencyAvg       | number   | No          | Percentage of time the VM is waiting to access swapped or compressed memory                                                       |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memorySharedAvg        | number   | No          | Shared memory in kilobytes                                                                                                        |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memorySlabRecl         | number   | No          | The part of the slab that can be reclaimed such as caches measured in kibibytes                                                   |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memorySlabUnrecl       | number   | No          | The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes                                       |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memorySwapInAvg        | number   | No          | Amount of memory swapped-in from host cache in kibibytes                                                                          |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memorySwapInRateAvg    | number   | No          | Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second                          |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memorySwapOutAvg       | number   | No          | Amount of memory swapped-out to host cache in kibibytes                                                                           |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memorySwapOutRateAvg   | number   | No          | Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second              |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memorySwapUsedAvg      | number   | No          | Space used for caching swapped pages in the host cache in kibibytes                                                               |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| memoryUsed             | number   | Yes         | Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes                                        |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| percentMemoryUsage     | number   | No          | Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise.   |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
| vmIdentifier           | string   | Yes         | Virtual Machine identifier associated with the memory metrics                                                                     |
+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+

Datatype: nicPerformance
^^^^^^^^^^^^^^^^^^^^^^^^

The nicPerformance datatype consists of the following fields which
describe the performance and errors of an of an identified virtual
network interface card:

+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                                    | Type     | Required?   | Description                                                                                                                                                                          |
+==========================================+==========+=============+======================================================================================================================================================================================+
| administrativeState                      | string   | No          | Administrative state: enum: ‘inService’, ‘outOfService’                                                                                                                              |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nicIdentifier                            | string   | Yes         | Network interface card identifier                                                                                                                                                    |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| operationalState                         | string   | No          | Operational state: enum: ‘inService’, ‘outOfService’                                                                                                                                 |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedBroadcastPacketsAccumulated      | number   | No          | Cumulative count of broadcast packets received as read at the end of the measurement interval                                                                                        |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedBroadcastPacketsDelta            | number   | No          | Count of broadcast packets received within the measurement interval                                                                                                                  |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedDiscardedPacketsAccumulated      | number   | No          | Cumulative count of discarded packets received as read at the end of the measurement interval                                                                                        |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedDiscardedPacketsDelta            | number   | No          | Count of discarded packets received within the measurement interval                                                                                                                  |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedErrorPacketsAccumulated          | number   | No          | Cumulative count of error packets received as read at the end of the measurement interval                                                                                            |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedErrorPacketsDelta                | number   | No          | Count of error packets received within the measurement interval                                                                                                                      |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedMulticastPacketsAccumulated      | number   | No          | Cumulative count of multicast packets received as read at the end of the measurement interval                                                                                        |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedMulticastPacketsDelta            | number   | No          | Count of multicast packets received within the measurement interval                                                                                                                  |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedOctetsAccumulated                | number   | No          | Cumulative count of octets received as read at the end of the measurement interval                                                                                                   |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedOctetsDelta                      | number   | No          | Count of octets received within the measurement interval                                                                                                                             |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedPercentDiscard                   | number   | No          | Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise.                  |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedPercentError                     | number   | No          | Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise.                          |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedTotalPacketsAccumulated          | number   | No          | Cumulative count of all packets received as read at the end of the measurement interval                                                                                              |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedTotalPacketsDelta                | number   | No          | Count of all packets received within the measurement interval                                                                                                                        |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedUnicastPacketsAccumulated        | number   | No          | Cumulative count of unicast packets received as read at the end of the measurement interval                                                                                          |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedUnicastPacketsDelta              | number   | No          | Count of unicast packets received within the measurement interval                                                                                                                    |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| receivedUtilization                      | number   | No          | Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise.         |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| speed                                    | number   | No          | Speed configured in mbps.                                                                                                                                                            |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedBroadcastPacketsAccumulated   | number   | No          | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval                                                                                     |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedBroadcastPacketsDelta         | number   | No          | Count of broadcast packets transmitted within the measurement interval                                                                                                               |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedDiscardedPacketsAccumulated   | number   | No          | Cumulative count of discarded packets transmitted as read at the end of the measurement interval                                                                                     |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedDiscardedPacketsDelta         | number   | No          | Count of discarded packets transmitted within the measurement interval                                                                                                               |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedErrorPacketsAccumulated       | number   | No          | Cumulative count of error packets transmitted as read at the end of the measurement interval                                                                                         |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedErrorPacketsDelta             | number   | No          | Count of error packets transmitted within the measurement interval                                                                                                                   |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedMulticastPacketsAccumulated   | number   | No          | Cumulative count of multicast packets transmitted as read at the end of the measurement interval                                                                                     |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedMulticastPacketsDelta         | number   | No          | Count of multicast packets transmitted within the measurement interval                                                                                                               |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedOctetsAccumulated             | number   | No          | Cumulative count of octets transmitted as read at the end of the measurement interval                                                                                                |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedOctetsDelta                   | number   | No          | Count of octets transmitted within the measurement interval                                                                                                                          |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedPercentDiscard                | number   | No          | Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise.         |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedPercentError                  | number   | No          | Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise.                    |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedTotalPacketsAccumulated       | number   | No          | Cumulative count of all packets transmitted as read at the end of the measurement interval                                                                                           |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedTotalPacketsDelta             | number   | No          | Count of all packets transmitted within the measurement interval                                                                                                                     |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedUnicastPacketsAccumulated     | number   | No          | Cumulative count of unicast packets transmitted as read at the end of the measurement interval                                                                                       |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedUnicastPacketsDelta           | number   | No          | Count of unicast packets transmitted within the measurement interval                                                                                                                 |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedUtilization                   | number   | No          | Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise.   |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| valuesAreSuspect                         | string   | Yes         | Enumeration: ‘true’ or ‘false’. If ‘true’ then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions.                                         |
+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: processorDimmAggregateThermalMargin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The processorDimmAggregateThermalMargin datatype provides intelligent
platform management interface (ipmi) processor dual inline memory module
aggregate thermal margin metrics; it consists of the following fields:

+--------------------------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------+
| Field                                            | Type     | Required?   | Description                                                                                                       |
+==================================================+==========+=============+===================================================================================================================+
| processorDimmAggregateThermal MarginIdentifier   | string   | Yes         | identifier for the aggregate thermal margin metrics from the processor dual inline memory module                  |
+--------------------------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------+
| thermalMargin                                    | number   | Yes         | the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point   |
+--------------------------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------+

Datatype: processStats
^^^^^^^^^^^^^^^^^^^^^^

The processStats datatype provides metrics on system processes; it
consists of the following fields:

+---------------------+----------+-------------+-------------------------------------------------------+
| Field               | Type     | Required?   | Description                                           |
+=====================+==========+=============+=======================================================+
| forkRate            | number   | No          | The number of threads created since the last reboot   |
+---------------------+----------+-------------+-------------------------------------------------------+
| processIdentifier   | string   | Yes         | processIdentifier                                     |
+---------------------+----------+-------------+-------------------------------------------------------+
| psStateBlocked      | number   | No          | The number of processes in a blocked state            |
+---------------------+----------+-------------+-------------------------------------------------------+
| psStatePaging       | number   | No          | The number of processes in a paging state             |
+---------------------+----------+-------------+-------------------------------------------------------+
| psStateRunning      | number   | No          | The number of processes in a running state            |
+---------------------+----------+-------------+-------------------------------------------------------+
| psStateSleeping     | number   | No          | The number of processes in a sleeping state           |
+---------------------+----------+-------------+-------------------------------------------------------+
| psStateStopped      | number   | No          | The number of processes in a stopped state            |
+---------------------+----------+-------------+-------------------------------------------------------+
| psStateZombie       | number   | No          | The number of processes in a zombie state             |
+---------------------+----------+-------------+-------------------------------------------------------+

‘Notification’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: notificationFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 

The notificationFields datatype consists of the following fields:

+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
| Field                       | Type               | Required?   | Description                                                                                                            |
+=============================+====================+=============+========================================================================================================================+
| additionalFields            | hashMap            | No          | Additional notification fields if needed                                                                               |
+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
| arrayOfNamedHashMap         | namedHashMap [ ]   | No          | Array of named hashMaps                                                                                                |
+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
| changeContact               | string             | No          | Identifier for a contact related to the change                                                                         |
+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
| changeIdentifier            | string             | Yes         | System or session identifier associated with the change                                                                |
+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
| changeType                  | string             | Yes         | Describes what has changed for the entity, for example: configuration changed, capability added, capability removed…   |
+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
| newState                    | string             | No          | New state of the entity, for example: ‘inService’, ‘maintenance’, ‘outOfService’                                       |
+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
| notificationFieldsVersion   | string             | Yes         | Version of the notificationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.      |
+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
| oldState                    | string             | No          | Previous state of the entity, for example: ‘inService’, ‘maintenance’, ‘outOfService’                                  |
+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
| stateInterface              | string             | No          | Card or port name of the entity that changed state                                                                     |
+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+

The fileReady notification event is used by 3GPP-compliant NFs to notify
ONAP that a PM file is available for upload. The notificationFields are
populated as follows:

**arrayOfNamedHashMap:** The array is named for the PM file as defined
in 3GPP TS 28.550. The array contains the following key value pairs:

-  **location** in the form protocol://ipAddress:port/path/filename;
   e.g. “location” :
   “ftpes://135.3.1.44:21/pmfiles/A20180531.1030+0600-1045+0600\_5gBts213.bin.gz”

-  **compression** containing the compression type used for the PM file;
   e.g. “compression” : “gzip”

-  **fileFormatType** containing the format type of the PM file; e.g.
   “fileFormatType” : “org.3GPP.32.435#measCollec”

-  **fileFormatVersion** containing the format version of the PM file;
   e.g. “fileFormatVersion” : “V10”

-  other vendor-defined key-value pairs as needed

**changeIdentifier:** set to PM\_MEAS\_FILES

**changeType:** set to fileReady

Other notificationFields are not used for fileReady.

‘Other’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: otherFields
^^^^^^^^^^^^^^^^^^^^^

The otherFields datatype defines fields for events belonging to the
'other' domain of the commonEventHeader domain enumeration; it consists
of the following fields:

+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+
| Field                 | Type                  | Required?   | Description                                                                                                  |
+=======================+=======================+=============+==============================================================================================================+
| arrayOfNamedHashMap   | arrayOfNamedHashMap   | No          | Array of named hashMaps                                                                                      |
+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+
| hashMap               | hashMap               | No          | Array of name-value pairs                                                                                    |
+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+
| jsonObjects           | arrayOfJsonObject     | No          | Array of JSON objects described by name, schema and other meta-information                                   |
+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+
| otherFieldsVersion    | string                | Yes         | Version of the otherFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.   |
+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+

‘perf3gpp’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: measDataCollection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The measDataCollection datatype defines a 3GPP measurement collection
structure aligned with the 3GPP PM format; it consists of the following
fields:

+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
| Field                           | Type           | Required?   | Description                                                                        |
+=================================+================+=============+====================================================================================+
| formatVersion                   | string         | No          | 3GPP PM reporting file format version from pre-standard TS 28.550 v2.0.0           |
+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
| granularityPeriod               | string         | Yes         | Granularity period for the PM report in seconds                                    |
+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
| measInfoList                    | measInfo [ ]   | Yes         | Array of measInfo measurements                                                     |
+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
| measObjInstIdList               | string [ ]     | No          | Array of monitored object local distinguished name ids per 3GPP TS 32.300          |
+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
| measuredEntityDn                | string         | Yes         | Distinguished name per 3GPP TS 28.550                                              |
+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
| measuredEntitySoftwareVersion   | string         | No          | Software version for the NF providing the PM data as specified in 3GPP TS 28.550   |
+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
| measuredEntityUserName          | string         | No          | User Definable name for the measured object per 3GPP TS 28.550                     |
+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+

 Datatype: measInfo
^^^^^^^^^^^^^^^^^^^

The measInfo datatype provides measurement information; it consists of
the following fields:

+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Field        | Type                                            | Required?   | Description                                                                                                                         |
+==============+=================================================+=============+=====================================================================================================================================+
| jobId        | string                                          | No          | Name of the measurement job                                                                                                         |
+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| measInfoId   | oneOf [ measInfoIdInteger, measInfoIdString ]   | No          | Measurement group Identifier                                                                                                        |
+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| measTypes    | oneOf [ measTypesInteger, measTypesString ]     | Yes         | Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings   |
+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| measValues   | measValues [ ]                                  | Yes         | Array of measValues                                                                                                                 |
+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+

Datatype: measInfoIdInteger
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The measInfoIdInteger datatype provides an integer measurement group
identifier; it consists of the following fields:

+---------------+-----------+-------------+----------------------------------------+
| Field         | Type      | Required?   | Description                            |
+===============+===========+=============+========================================+
| iMeasInfoId   | integer   | Yes         | Integer measurement group Identifier   |
+---------------+-----------+-------------+----------------------------------------+

Datatype: measInfoIdString
^^^^^^^^^^^^^^^^^^^^^^^^^^

The measInfoIdString datatype provides a string measurement group
identifier; it consists of the following fields:

+---------------+-----------+-------------+---------------------------------------+
| Field         | Type      | Required?   | Description                           |
+===============+===========+=============+=======================================+
| sMeasInfoId   | integer   | Yes         | String measurement group Identifier   |
+---------------+-----------+-------------+---------------------------------------+

Datatype: measResultInteger
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The measResultInteger datatype provides an integer 3GPP PM measurement
result; it consists of the following fields:

+----------+-----------+-------------+------------------------------------+
| Field    | Type      | Required?   | Description                        |
+==========+===========+=============+====================================+
| p        | integer   | Yes         | Integer reference to the counter   |
+----------+-----------+-------------+------------------------------------+
| iValue   | integer   | Yes         | Integer counter value              |
+----------+-----------+-------------+------------------------------------+

Datatype: measResultNull
^^^^^^^^^^^^^^^^^^^^^^^^

The measResultNull datatype provides a null 3GPP PM measurement result;
it consists of the following fields:

+----------+-----------+-------------+------------------------------------+
| Field    | Type      | Required?   | Description                        |
+==========+===========+=============+====================================+
| p        | integer   | Yes         | Integer reference to the counter   |
+----------+-----------+-------------+------------------------------------+
| isNull   | string    | Yes         | Enumeration: ‘true’ or ‘false’     |
+----------+-----------+-------------+------------------------------------+

Datatype: measResultNumber
^^^^^^^^^^^^^^^^^^^^^^^^^^

The measResultNumber datatype provides a number 3GPP PM measurement
result; it consists of the following fields:

+----------+-----------+-------------+------------------------------------+
| Field    | Type      | Required?   | Description                        |
+==========+===========+=============+====================================+
| p        | integer   | Yes         | Integer reference to the counter   |
+----------+-----------+-------------+------------------------------------+
| rValue   | number    | Yes         | Number counter value               |
+----------+-----------+-------------+------------------------------------+

Datatype: measResultString
^^^^^^^^^^^^^^^^^^^^^^^^^^

The measResultString datatype provides a string 3GPP PM measurement
result; it consists of the following fields:

+----------+-----------+-------------+------------------------------------+
| Field    | Type      | Required?   | Description                        |
+==========+===========+=============+====================================+
| p        | integer   | Yes         | Integer reference to the counter   |
+----------+-----------+-------------+------------------------------------+
| sValue   | string    | Yes         | String counter value               |
+----------+-----------+-------------+------------------------------------+

Datatype: measTypesInteger
^^^^^^^^^^^^^^^^^^^^^^^^^^

The measTypesInteger datatype provides an array of integer measurement
identifiers associated with the measurement results; it consists of the
following fields:

+------------------+---------------+-------------+------------------------------------------------------------------------------------+
| Field            | Type          | Required?   | Description                                                                        |
+==================+===============+=============+====================================================================================+
| iMeasTypesList   | integer [ ]   | Yes         | Array of integer measurement identifiers associated with the measurement results   |
+------------------+---------------+-------------+------------------------------------------------------------------------------------+

Datatype: measTypesString
^^^^^^^^^^^^^^^^^^^^^^^^^

The measTypesString datatype provides an array of string measurement
identifiers associated with the measurement results; it consists of the
following fields:

+------------------+--------------+-------------+-----------------------------------------------------------------------------------+
| Field            | Type         | Required?   | Description                                                                       |
+==================+==============+=============+===================================================================================+
| sMeasTypesList   | string [ ]   | Yes         | Array of string measurement identifiers associated with the measurement results   |
+------------------+--------------+-------------+-----------------------------------------------------------------------------------+

Datatype: measValues
^^^^^^^^^^^^^^^^^^^^

The measValues datatype provides 3GPP measurement values; it consists of
the following fields:

+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+
| Field             | Type                                                                                                                | Required?   | Description                                                                       |
+===================+=====================================================================================================================+=============+===================================================================================+
| measObjAddlFlds   | hashMap                                                                                                             | No          |  Additional key-value pairs if needed                                             |
+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+
| measObjInstId     | measDataCollection                                                                                                  | Yes         | Monitored object local distinguished name per 3GPP TS 32.300 and 3GPP TS 32.432   |
+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+
| measResults       | Array of items where each item is oneOf [ measResultInteger, measResultNull, measResultNumber, measResultString ]   | Yes         | Array of results                                                                  |
+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+
| suspectFlag       | string                                                                                                              | No          | Enumeration: ‘true’, ‘false’. Indicates if the values are suspect                 |
+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+

Datatype: perf3gppFields
^^^^^^^^^^^^^^^^^^^^^^^^

The perf3gppFields datatype defines fields for 3GPP PM format events,
based on 3GPP TS 28.550, belonging to the 'perf3gpp' domain of the
commonEventHeader domain enumeration; it consists of the following
fields:

+-------------------------+----------------------+-------------+-----------------------------------------+
| Field                   | Type                 | Required?   | Description                             |
+=========================+======================+=============+=========================================+
| eventAddlFields         | hashMap              | No          |  Additional key-value pairs if needed   |
+-------------------------+----------------------+-------------+-----------------------------------------+
| measDataCollection      | measDataCollection   | Yes         | 3GPP measurement collection structure   |
+-------------------------+----------------------+-------------+-----------------------------------------+
| perf3gppFieldsVersion   | string               | Yes         | Version of the perf3gpp event           |
+-------------------------+----------------------+-------------+-----------------------------------------+

‘pnfRegistration’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: pnfRegistrationFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The pnfRegistrationFields datatype defines fields for events belonging
to the 'pnfRegistration' domain of the commonEventHeader domain
enumeration; it consists of the following fields:

+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| Field                          | Type      | Required?   | Description                                                                                                            |
+================================+===========+=============+========================================================================================================================+
| additionalFields               | hashMap   | No          | Additional pnfRegistration fields if needed                                                                            |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| lastServiceDate                | string    | No          | TS 32.692 dateOfLastService = date of last service; e.g. 15022017                                                      |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| macAddress                     | string    | No          | MAC address of OAM interface of the unit                                                                               |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| manufactureDate                | string    | No          | TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016                                                   |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| modelNumber                    | string    | No          | TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model                          |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| oamV4IpAddress                 | string    | No          | IPv4 m-plane IP address to be used by the manager to contact the PNF                                                   |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| oamV6IpAddress                 | string    | No          | IPv6 m-plane IP address to be used by the manager to contact the PNF                                                   |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| pnfRegistrationFieldsVersion   | string    | Yes         | Version of the pnfRegistrationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.   |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| serialNumber                   | string    | No          | TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3                                                       |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| softwareVersion                | string    | No          | TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201                                                  |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| unitFamily                     | string    | No          | TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU                                                     |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| unitType                       | string    | No          | TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale                                               |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
| vendorName                     | string    | No          | TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor                                      |
+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+

‘State Change’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 

Datatype: stateChangeFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The stateChangeFields datatype consists of the following fields:

+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
| Field                      | Type      | Required?   | Description                                                                                                        |
+============================+===========+=============+====================================================================================================================+
| additionalFields           | hashMap   | No          | Additional stateChange fields if needed                                                                            |
+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
| newState                   | string    | Yes         | New state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’                                                |
+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
| oldState                   | string    | Yes         | Previous state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’                                           |
+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
| stateChangeFieldsVersion   | string    | Yes         | Version of the stateChangeFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.   |
+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
| stateInterface             | string    | Yes         | Card or port name of the entity that changed state                                                                 |
+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+

‘Syslog’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: syslogFields
^^^^^^^^^^^^^^^^^^^^^^

The syslogFields datatype consists of the following fields:

+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                 | Type      | Required?   | Description                                                                                                                                                                          |
+=======================+===========+=============+======================================================================================================================================================================================+
| additionalFields      | hashMap   | No          | Additional syslog fields if needed Ex: {“name1”: ”value1”, “name2: “value2” … }                                                                                                      |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventSourceHost       | string    | No          | Hostname of the device                                                                                                                                                               |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventSourceType       | string    | Yes         | Examples: ‘other’, ‘router’, ‘switch’, ‘host’, ‘card’, ‘port’, ‘slotThreshold’, ‘portThreshold’, ‘virtualMachine’, ‘virtualNetworkFunction’                                          |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogFacility        | integer   | No          | Numeric code from 0 to 23 for facility:                                                                                                                                              |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 0 kernel messages                                                                                                                                                                    |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 1 user-level messages                                                                                                                                                                |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 2 mail system                                                                                                                                                                        |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 3 system daemons                                                                                                                                                                     |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 4 security/authorization messages                                                                                                                                                    |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 5 messages generated internally by syslogd                                                                                                                                           |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 6 line printer subsystem                                                                                                                                                             |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 7 network news subsystem                                                                                                                                                             |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 8 UUCP subsystem                                                                                                                                                                     |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 9 clock daemon                                                                                                                                                                       |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 10 security/authorization messages                                                                                                                                                   |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 11 FTP daemon                                                                                                                                                                        |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 12 NTP subsystem                                                                                                                                                                     |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 13 log audit                                                                                                                                                                         |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 14 log alert                                                                                                                                                                         |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 15 clock daemon (note 2)                                                                                                                                                             |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 16 local use 0 (local0)                                                                                                                                                              |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 17 local use 1 (local1)                                                                                                                                                              |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 18 local use 2 (local2)                                                                                                                                                              |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 19 local use 3 (local3)                                                                                                                                                              |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 20 local use 4 (local4)                                                                                                                                                              |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 21 local use 5 (local5)                                                                                                                                                              |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 22 local use 6 (local6)                                                                                                                                                              |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 23 local use 7 (local7 )                                                                                                                                                             |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogFieldsVersion   | string    | Yes         | Version of the syslogFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.                                                                          |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogMsg             | string    | Yes         | Syslog message                                                                                                                                                                       |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogMsgHost         | string    | No          | Hostname parsed from non-VES syslog message                                                                                                                                          |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogPri             | integer   | No          | 0-192                                                                                                                                                                                |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | Combined Severity and Facility (see rfc5424)                                                                                                                                         |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogProc            | string    | No          | Identifies the application that originated the message                                                                                                                               |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogProcId          | number    | No          | The process number assigned by the OS when the application was started                                                                                                               |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogSData           | string    | No          | A <space> separated list of key=”value” pairs following the rfc5424 standard for SD-ELEMENT.                                                                                         |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | ***Deprecated ***                                                                                                                                                                    |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs                                                                                    |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogSdId            | string    | No          | 0-32 char in format name@number,                                                                                                                                                     |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | i.e., ourSDID@32473                                                                                                                                                                  |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogSev             | string    | No          | Level-of-severity text enumeration defined below:                                                                                                                                    |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | *Text* *Sev* *Description*                                                                                                                                                           |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | Emergency 0 system is unusable                                                                                                                                                       |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | Alert 1 action must be taken immediately                                                                                                                                             |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | Critical 2 critical conditions                                                                                                                                                       |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | Error 3 error conditions                                                                                                                                                             |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | Warning 4 warning conditions                                                                                                                                                         |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | Notice 5 normal but significant condition                                                                                                                                            |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | Info 6 Informational messages                                                                                                                                                        |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | Debug 7 debug-level messages                                                                                                                                                         |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogTag             | string    | Yes         | Also known as MsgId. Brief non-spaced text indicating the type of message such as ‘TCPOUT’ or ‘BGP\_STATUS\_CHANGE’; ‘NILVALUE’ should be used when no other value can be provided   |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogTs              | string    | No          | Timestamp parsed from non-VES syslog message                                                                                                                                         |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| syslogVer             | number    | No          | IANA assigned version of the syslog protocol specification:                                                                                                                          |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 0: VES                                                                                                                                                                               |
|                       |           |             |                                                                                                                                                                                      |
|                       |           |             | 1: IANA RFC5424                                                                                                                                                                      |
+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Examples of syslogSData :

Preferred

    ts=”1985-04-12T23:20:50.52Z” tag=”BGP\_NEIGHBOR\_DOWN” msg=”The BGP
    session to neighbor 10.10.10.10 is down”

Deprecated

    [attinc@1234 ts=”1985-04-12T23:20:50.52Z” tag=”BGP\_NEIGHBOR\_DOWN”
    msg=”The BGP session to neighbor 10.10.10.10 is down”]

Syslog references:

https://tools.ietf.org/html/rfc5424#section-6

    https://www.iana.org/assignments/syslog-parameters/syslog-parameters.xhtml

‘Threshold Crossing Alert’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: counter
^^^^^^^^^^^^^^^^^

The counter datatype consists of the following fields:

+---------------------+-----------+-------------+--------------------------------------------------------------------------------+
| Field               | Type      | Required?   | Description                                                                    |
+=====================+===========+=============+================================================================================+
| criticality         | string    | Yes         | Enumeration: ‘CRIT’, ‘MAJ’                                                     |
+---------------------+-----------+-------------+--------------------------------------------------------------------------------+
| hashMap             | hashMap   | Yes         | Key is the name of the counter and value is the current value of the counter   |
+---------------------+-----------+-------------+--------------------------------------------------------------------------------+
| threshholdCrossed   | string    | Yes         | Last threshold that was crossed                                                |
+---------------------+-----------+-------------+--------------------------------------------------------------------------------+

Datatype: thresholdCrossingAlertFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The thresholdCrossingAlertFields datatype consists of the following
fields:

+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| Field                             | Type          | Required?   | Description                                                                                                                   |
+===================================+===============+=============+===============================================================================================================================+
| additionalFields                  | hashMap       | No          | Additional threshold crossing alert fields if needed                                                                          |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| additionalParameters              | counter [ ]   | Yes         | Array of performance counters                                                                                                 |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| alertAction                       | string        | Yes         | Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’                                                                                           |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| alertDescription                  | string        | Yes         | Unique short alert description (e.g., NE-CPUMEM)                                                                              |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| alertType                         | string        | Yes         | Enumeration: ‘CARD-ANOMALY’, ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, ‘SERVICE-ANOMALY’                                         |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| alertValue                        | string        | No          | Calculated API value (if applicable)                                                                                          |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| associatedAlertIdList             | string [ ]    | No          | List of eventIds associated with the event being reported                                                                     |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| collectionTimestamp               | string        | Yes         | Time when the performance collector picked up the data; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’     |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| dataCollector                     | string        | No          | Specific performance collector instance used                                                                                  |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| elementType                       | string        | No          | Type of network element (internal AT&T field)                                                                                 |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| eventSeverity                     | string        | Yes         | Event severity or priority enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’                                     |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| eventStartTimestamp               | string        | Yes         | Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’              |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| interfaceName                     | string        | No          | Physical or logical port or card (if applicable)                                                                              |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| networkService                    | string        | No          | Network name (internal AT&T field)                                                                                            |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| possibleRootCause                 | string        | No          | Reserved for future use                                                                                                       |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
| thresholdCrossing FieldsVersion   | string        | Yes         | Version of the thresholdCrossingAlertFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.   |
+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+

Technology Specific Datatypes
-----------------------------

Mobile Flow’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: gtpPerFlowMetrics
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The gtpPerFlowMetrics datatype consists of the following fields:

+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                              | Type      | Required?   | Description                                                                                                                                                                                                       |
+====================================+===========+=============+===================================================================================================================================================================================================================+
| avgBitErrorRate                    | number    | Yes         | Average bit error rate                                                                                                                                                                                            |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| avgPacketDelayVariation            | number    | Yes         | Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets                             |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| avgPacketLatency                   | number    | Yes         | Average delivery latency                                                                                                                                                                                          |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| avgReceiveThroughput               | number    | Yes         | Average receive throughput                                                                                                                                                                                        |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| avgTransmitThroughput              | number    | Yes         | Average transmit throughput                                                                                                                                                                                       |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| durConnectionFailedStatus          | number    | No          | Duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval                             |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| durTunnelFailedStatus              | number    | No          | Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval                                            |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowActivatedBy                    | string    | No          | Endpoint activating the flow                                                                                                                                                                                      |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowActivationEpoch                | number    | Yes         | Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available                                                         |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowActivationMicrosec             | number    | Yes         | Integer microseconds for the start of the flow connection                                                                                                                                                         |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowActivationTime                 | string    | No          | Time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’   |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowDeactivatedBy                  | string    | No          | Endpoint deactivating the flow                                                                                                                                                                                    |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowDeactivationEpoch              | number    | Yes         | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time                                                                                                                                |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowDeactivationMicrosec           | number    | Yes         | Integer microseconds for the start of the flow connection                                                                                                                                                         |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowDeactivationTime               | string    | Yes         | Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’                                                                 |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowStatus                         | string    | Yes         | Connection status at reporting time as a working / inactive / failed indicator value                                                                                                                              |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gtpConnectionStatus                | string    | No          | Current connection state at reporting time                                                                                                                                                                        |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gtpTunnelStatus                    | string    | No          | Current tunnel state at reporting time                                                                                                                                                                            |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipTosCountList                     | hashMap   | No          | Array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow      |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipTosList                          | string    | No          | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255'                                                                                                               |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| largePacketRtt                     | number    | No          | large packet round trip time                                                                                                                                                                                      |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| largePacketThreshold               | number    | No          | large packet threshold being applied                                                                                                                                                                              |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| maxPacketDelayVariation            | number    | Yes         | Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets                      |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| maxReceiveBitRate                  | number    | No          | maximum receive bit rate"                                                                                                                                                                                         |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| maxTransmitBitRate                 | number    | No          | maximum transmit bit rate                                                                                                                                                                                         |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mobileQciCosCountList              | hashMap   | No          | array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow                                      |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mobileQciCosList                   | string    | No          | Array of unique LTE QCI or UMTS class-of-service values observed in the flow                                                                                                                                      |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numActivationFailures              | number    | Yes         | Number of failed activation requests, as observed by the reporting node                                                                                                                                           |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numBitErrors                       | number    | Yes         | number of errored bits                                                                                                                                                                                            |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numBytesReceived                   | number    | Yes         | number of bytes received, including retransmissions                                                                                                                                                               |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numBytesTransmitted                | number    | Yes         | number of bytes transmitted, including retransmissions                                                                                                                                                            |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numDroppedPackets                  | number    | Yes         | number of received packets dropped due to errors per virtual interface                                                                                                                                            |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numGtpEchoFailures                 | number    | No          | Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2                                                                                      |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numGtpTunnelErrors                 | number    | No          | Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1                                                                                              |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numHttpErrors                      | number    | No          | Http error count                                                                                                                                                                                                  |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numL7BytesReceived                 | number    | Yes         | number of tunneled layer 7 bytes received, including retransmissions                                                                                                                                              |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numL7BytesTransmitted              | number    | Yes         | number of tunneled layer 7 bytes transmitted, excluding retransmissions                                                                                                                                           |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numLostPackets                     | number    | Yes         | number of lost packets                                                                                                                                                                                            |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numOutOfOrderPackets               | number    | Yes         | number of out-of-order packets                                                                                                                                                                                    |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numPacketErrors                    | number    | Yes         | number of errored packets                                                                                                                                                                                         |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numPacketsReceivedExclRetrans      | number    | Yes         | number of packets received, excluding retransmission                                                                                                                                                              |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numPacketsReceivedInclRetrans      | number    | Yes         | number of packets received, including retransmission                                                                                                                                                              |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numPacketsTransmittedInclRetrans   | number    | Yes         | number of packets transmitted, including retransmissions                                                                                                                                                          |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numRetries                         | number    | Yes         | number of packet retrie                                                                                                                                                                                           |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numTimeouts                        | number    | Yes         | number of packet timeouts                                                                                                                                                                                         |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numTunneledL7BytesReceived         | number    | Yes         | number of tunneled layer 7 bytes received, excluding retransmissions                                                                                                                                              |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| roundTripTime                      | number    | Yes         | Round Trip time                                                                                                                                                                                                   |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tcpFlagCountList                   | hashMap   | No          | Array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow                                                                      |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tcpFlagList                        | string    | No          | Array of unique TCP Flags observed in the flow                                                                                                                                                                    |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| timeToFirstByte                    | number    | Yes         | Time in milliseconds between the connection activation and first byte received                                                                                                                                    |
+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: mobileFlowFields
^^^^^^^^^^^^^^^^^^^^^^^^^^

The mobileFlowFields datatype consists of the following fields:

+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                     | Type                 | Required?   | Description                                                                                                                                                                                  |
+===========================+======================+=============+==============================================================================================================================================================================================+
| additionalFields          | hashMap              | No          | Additional mobileFlow fields if needed                                                                                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| applicationType           | string               | No          | Application type inferred                                                                                                                                                                    |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| appProtocolType           | string               | No          | Application protocol                                                                                                                                                                         |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| appProtocolVersion        | string               | No          | Application version                                                                                                                                                                          |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cid                       | string               | No          | Cell Id                                                                                                                                                                                      |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| connectionType            | string               | No          | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc                                                                                                                         |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ecgi                      | string               | No          | Evolved Cell Global Id                                                                                                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowDirection             | string               | Yes         | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gtpPerFlowMetrics         | gtpPer FlowMetrics   | Yes         | Mobility GTP Protocol per flow metrics                                                                                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gtpProtocolType           | string               | No          | GTP protocol                                                                                                                                                                                 |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gtpVersion                | string               | No          | GTP protocol version                                                                                                                                                                         |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| httpHeader                | string               | No          | HTTP request header, if the flow connects to a node referenced by HTTP                                                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| imei                      | string               | No          | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device                                                                                                        |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| imsi                      | string               | No          | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device                                                                                                        |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipProtocolType            | string               | Yes         | IP protocol type e.g., TCP, UDP, RTP...                                                                                                                                                      |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipVersion                 | string               | Yes         | IP protocol version e.g., IPv4, IPv6                                                                                                                                                         |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lac                       | string               | No          | Location area code                                                                                                                                                                           |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mcc                       | string               | No          | Mobile country code                                                                                                                                                                          |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mnc                       | string               | No          | Mobile network code                                                                                                                                                                          |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mobileFlowFieldsVersion   | string               | Yes         | Version of the mobileFlowFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.                                                                              |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| msisdn                    | string               | No          | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| otherEndpointIpAddress    | string               | Yes         | IP address for the other endpoint, as used for the flow being reported on                                                                                                                    |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| otherEndpointPort         | integer              | Yes         | IP Port for the reporting entity, as used for the flow being reported on                                                                                                                     |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| otherFunctionalRole       | string               | No          | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF...                                                                                          |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| rac                       | string               | No          | Routing area code                                                                                                                                                                            |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| radioAccessTechnology     | string               | No          | Radio Access Technology e.g., 2G, 3G, LTE                                                                                                                                                    |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| reportingEndpointIpAddr   | string               | Yes         | IP address for the reporting entity, as used for the flow being reported on                                                                                                                  |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| reportingEndpointPort     | integer              | Yes         | IP port for the reporting entity, as used for the flow being reported on                                                                                                                     |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sac                       | string               | No          | Service area code                                                                                                                                                                            |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| samplingAlgorithm         | integer              | No          | Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied   |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tac                       | string               | No          | Transport area code                                                                                                                                                                          |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tunnelId                  | string               | No          | Tunnel identifier                                                                                                                                                                            |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vlanId                    | string               | No          | VLAN identifier used by this flow                                                                                                                                                            |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

‘SipSignaling’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: sipSignalingFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The sipSignalingFields datatype communicates information about sip
signaling messages, parameters and signaling state; it consists of the
following fields:

+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| Field                       | Type                 | Required?   | Description                                                                                                         |
+=============================+======================+=============+=====================================================================================================================+
| additionalInformation       | hashMap              | No          | Additional sipSignaling fields                                                                                      |
+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| compressedSip               | string               | No          | The full SIP request/response including headers and bodies                                                          |
+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| correlator                  | string               | Yes         | Constant across all events on this call                                                                             |
+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| localIpAddress              | string               | Yes         | Ip address on xNF                                                                                                   |
+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| localPort                   | string               | Yes         | Port on xNF                                                                                                         |
+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| remoteIpAddress             | string               | Yes         | IP address of peer endpoint                                                                                         |
+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| remotePort                  | string               | Yes         | Port of peer endpoint                                                                                               |
+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| sipSignalingFieldsVersion   | string               | Yes         | Version of the sipSignalingFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.   |
+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| summarySip                  | string               | No          | The SIP Method or Response (‘INVITE’, ‘200 OK’, ‘BYE’, etc)                                                         |
+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| vendorNfNameFields          | vendorNfNameFields   | Yes         | Vendor, NF and nfModule names                                                                                       |
+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+

‘Voice Quality’ Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: endOfCallVqmSummaries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The endOfCallVqmSummaries datatype provides end of call voice quality
metrics; it consists of the following fields:

+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                           | Type     | Required?   | Description                                                                                                                                                                                                      |
+=================================+==========+=============+==================================================================================================================================================================================================================+
| adjacencyName                   | string   | Yes         | Adjacency name                                                                                                                                                                                                   |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointAverageJitter           | number   | No          | Endpoint average jitter                                                                                                                                                                                          |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointDescription             | string   | Yes         | Enumeration: ‘Caller’, ‘Callee’                                                                                                                                                                                  |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointMaxJitter               | number   | No          | Endpoint maximum jitter                                                                                                                                                                                          |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpOctetsDiscarded      | number   | No          | Endpoint RTP octets discarded                                                                                                                                                                                    |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpOctetsLost           | number   | No          | Endpoint RTP octets lost                                                                                                                                                                                         |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpOctetsReceived       | number   | No          | Endpoint RTP octets received                                                                                                                                                                                     |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpOctetsSent           | number   | No          | Endpoint RTP octets sent                                                                                                                                                                                         |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpPacketsDiscarded     | number   | No          | Endpoint RTP packets discarded                                                                                                                                                                                   |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpPacketsLost          | number   | No          | Endpoint RTP packets lost                                                                                                                                                                                        |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpPacketsReceived      | number   | No          | Endpoint RTP packets received                                                                                                                                                                                    |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpPacketsSent          | number   | No          | Endpoint RTP packets sent                                                                                                                                                                                        |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localAverageJitter              | number   | No          | Local average jitter                                                                                                                                                                                             |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localAverageJitterBufferDelay   | number   | No          | Local average jitter buffer delay                                                                                                                                                                                |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localMaxJitter                  | number   | No          | Local maximum jitter                                                                                                                                                                                             |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localMaxJitterBufferDelay       | number   | No          | Local max jitter buffer delay                                                                                                                                                                                    |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpOctetsDiscarded         | number   | No          | Local RTP octets discarded                                                                                                                                                                                       |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpOctetsLost              | number   | No          | Local RTP octets lost                                                                                                                                                                                            |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpOctetsReceived          | number   | No          | Local RTP octets received                                                                                                                                                                                        |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpOctetsSent              | number   | No          | Local RTP octets sent                                                                                                                                                                                            |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpPacketsDiscarded        | number   | No          | Local RTP packets discarded                                                                                                                                                                                      |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpPacketsLost             | number   | No          | Local RTP packets lost                                                                                                                                                                                           |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpPacketsReceived         | number   | No          | Local RTP packets received                                                                                                                                                                                       |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpPacketsSent             | number   | No          | Local RTP packets sent                                                                                                                                                                                           |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mosCqe                          | number   | No          | Decimal range from 1 to 5 (1 decimal place)                                                                                                                                                                      |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| oneWayDelay                     | number   | No          | one-way path delay in milliseconds                                                                                                                                                                               |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| packetLossPercent               | number   | No          | Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places)   |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| rFactor                         | number   | No          | rFactor from 0 to 100                                                                                                                                                                                            |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| roundTripDelay                  | number   | No          | Round trip delay in milliseconds                                                                                                                                                                                 |
+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: voiceQualityFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The voiceQualityFields datatype provides statistics related to customer
facing voice products; consists of the following fields:

+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| Field                       | Type                     | Required?   | Description                                                                                                         |
+=============================+==========================+=============+=====================================================================================================================+
| additionalInformation       | hashMap                  | No          | Additional voice quality fields                                                                                     |
+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| calleeSideCodec             | string                   | Yes         | Callee codec for the call                                                                                           |
+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| callerSideCodec             | string                   | Yes         | Caller codec for the call                                                                                           |
+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| correlator                  | string                   | Yes         | Constant across all events on this call                                                                             |
+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| endOfCallVqmSummaries       | endOfCallVqm Summaries   | No          | End of call voice quality metric summaries                                                                          |
+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| phoneNumber                 | string                   | No          | Phone number associated with the correlator                                                                         |
+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| midCallRtcp                 | string                   | Yes         | Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers)                                              |
+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| vendorNfNameFields          | vendorNfNameFields       | Yes         | Vendor, NF and nfModule names                                                                                       |
+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
| voiceQualityFieldsVersion   | string                   | Yes         | Version of the voiceQualityFields block as “#.#” where # is a digit; see section 1 for the correct digits to use.   |
+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+

Exceptions
==========

RESTful Web Services Exceptions
-------------------------------

RESTful services generate and send exceptions to clients in response to
invocation errors. Exceptions send HTTP status codes (specified later in
this document for each operation). HTTP status codes may be followed by
an optional JSON exception structure described below. Two types of
exceptions may be defined: service exceptions and policy exceptions.

+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Field Name**   | **Data Type**              | **Required?**   | **Description**                                                                                                                                                                                                                                                        |
+==================+============================+=================+========================================================================================================================================================================================================================================================================+
| messageId        | xs:string                  | Yes             | Unique message identifier of the format ‘ABCnnnn’ where ‘ABC’ is either ‘SVC’ for Service Exceptions or ‘POL’ for Policy Exception.                                                                                                                                    |
|                  |                            |                 |                                                                                                                                                                                                                                                                        |
|                  |                            |                 | Exception numbers may be in the range of 0001 to 9999 where :                                                                                                                                                                                                          |
|                  |                            |                 |                                                                                                                                                                                                                                                                        |
|                  |                            |                 | -  0001 to 2999 are defined by OMA (see OMA’s `Common definitions for RESTful Network APIs <http://technical.openmobilealliance.org/Technical/release_program/docs/REST_NetAPI_Common/V1_0-20120417-C/OMA-TS-REST_NetAPI_Common-V1_0-20120417-C.pdf>`__ for details)   |
|                  |                            |                 |                                                                                                                                                                                                                                                                        |
|                  |                            |                 | -  3000-9999 are available and undefined                                                                                                                                                                                                                               |
+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text             | xs:string                  | Yes             | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1                                                                                                                                      |
+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| variables        | xs:string [0..unbounded]   | No              | List of zero or more strings that represent the contents of the variables used by the message text.                                                                                                                                                                    |
+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| url              | xs:anyUrl                  | No              | Hyperlink to a detailed error resource (e.g., an HTML page for browser user agents).                                                                                                                                                                                   |
+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Service Exceptions
------------------

   When a service is not able to process a request, and retrying the
   request with the same information will also result in a failure, and
   the issue is not related to a service policy issue, then the service
   will issue a fault using the service exception fault message.
   Examples of service exceptions include invalid input, lack of
   availability of a required resource or a processing error.

   A service exception uses the letters 'SVC' at the beginning of the
   message identifier. ‘SVC’ service exceptions used by the VES Event
   Listener API are defined below.

+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
| *MessageId*   | *Description / Comment*               | *Text*                                                        | *Variables*                                   | *Parent HTTP Code*   |
+===============+=======================================+===============================================================+===============================================+======================+
| SVC0001       | General service error (see SVC2000)   | <custom error message>                                        | None                                          | 400                  |
+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
| SVC0002       | Bad parameter                         | Invalid input value for message part %1                       | %1: message part                              | 400                  |
+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
| SVC1000       | No server resources                   | No server resources available to process the request          | None                                          | 500                  |
+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
| SVC2000       | More elaborate version of SVC0001     | The following service error occurred: %1. Error code is %2.   | %1: human readable description of the error   | 400                  |
|               |                                       |                                                               |                                               |                      |
|               |                                       |                                                               | %2: error code                                |                      |
+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+

    Table - Service Exceptions

Policy Exceptions
-----------------

   When a service is not able to complete because the request fails to
   meet a policy criteria, then the service will issue a fault using the
   policy exception fault message. To clarify how a policy exception
   differs from a service exception, consider that all the input to an
   operation may be valid as meeting the required input for the
   operation (thus no service exception), but using that input in the
   execution of the service may result in conditions that require the
   service not to complete. Examples of policy exceptions include
   privacy violations, requests not permitted under a governing service
   agreement or input content not acceptable to the service provider.

   A Policy Exception uses the letters 'POL' at the beginning of the
   message identifier. ‘POL’ policy exceptions used by the VES Event
   Listener API are defined below.

+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
| *MessageId*   | *Description / Comment*              | *Text*                                                       | *Variables*                                   | *Parent HTTP Code*   |
+===============+======================================+==============================================================+===============================================+======================+
| POL0001       | General policy error (see POL2000)   | A policy error occurred.                                     | None                                          | 401                  |
+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
| POL1009       | User not provisioned for service     | User has not been provisioned for service                    | None                                          | 401                  |
+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
| POL1010       | User suspended from service          | User has been suspended from service                         | None                                          | 401                  |
+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
| POL2000       | More elaborate version of POL0001    | The following policy error occurred: %1. Error code is %2.   | %1: human readable description of the error   | 401                  |
|               |                                      |                                                              |                                               |                      |
|               |                                      |                                                              | %2: error code                                |                      |
+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
| POL9003       | Message size exceeds limit           | Message content size exceeds the allowable limit             | None                                          | 400                  |
+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+

    Table - Policy Exceptions

RESTful Web Services Definition
===============================

REST Operation Overview
----------------------- 

REST Operation Summary
~~~~~~~~~~~~~~~~~~~~~~

+------------------------+------------+----------------------------------------------------------------------------+
| **Operation Action**   | **HTTP**   | **Resource URL relative to {ServerRoot}, which is defined in section 3**   |
|                        |            |                                                                            |
|                        | **Verb**   |                                                                            |
+------------------------+------------+----------------------------------------------------------------------------+
| publishAnyEvent        | POST       | /eventListener/v{apiVersion}                                               |
+------------------------+------------+----------------------------------------------------------------------------+
| publishEventBatch      | POST       | /eventListener/v{apiVersion}/eventBatch                                    |
+------------------------+------------+----------------------------------------------------------------------------+

Table - REST Operation Summary

Api Versioning
~~~~~~~~~~~~~~

apiVersion is used to describe the major version number of the event
listener API (which is the same as the major version number of this
specification). When this number changes, the implication is: the new
major version will break clients of older major versions in some way, if
they try to use the new API without modification (e.g., unmodified v1
clients would not be able to use v2 without error).

The Event Listener shall provide the following HTTP headers in response
to all requests. Additionally, clients may populate these headers on
requests to indicate the specific version they are interested in.

-  X-MinorVersion: 0

-  X-PatchVersion: 0

-  X-LatestVersion: 7.1

If a client requests major version 7 (per the REST resource URL) and
does not specify the above headers, then they will be provided with the
latest patch version of 7.0.x (which is 7.0.1). If the client wants a
particular minor version of major version 7, then they need to supply
the X-MinorVersion header with their request. For example, if they
request major version 7 with X-MinorVersion: 1, they will get the latest
patch version of 7.1, which is 7.1.0.

Buffering of Events 
~~~~~~~~~~~~~~~~~~~~

{ServerRoot} is defined in section 3 of this document, which defines the
REST resource URL. One or more FQDNs may be provisioned in an event
source when it is instantiated or updated. If an event source is unable
to reach any of the provisioned FQDNs, it should buffer the event data
specified below, up to a maximum of 1 hour, until a connection can be
established and the events can be successfully delivered to the VES
Event Listener service.

xNFs acting as event sources should not send syslog events to the VES
Event Listener during debug mode (which is controlled via the Netconf
management interface), but should store syslog events locally for
access, and possible FTP transfer, via the xNF console (e.g., command
line interface).

If the internal event source event buffer or local storage should
overflow, then the event source should send a Fault event, and should
discard events in a first-in, first-out (FIFO) manner (i.e., discard
oldest events first).

Message Size
~~~~~~~~~~~~

Message size should be limited to 2 megabytes of uncompressed text sent
as application/json.

Operation: publishAnyEvent
--------------------------

Functional Behavior
~~~~~~~~~~~~~~~~~~~

Allows authorized clients to publish any single event to the VES event
listener.

-  Supports only secure HTTPS (one way SSL) access.

-  Uses the HTTP verb POST

-  Supports JSON content types

-  Provides HTTP response codes as well as Service and Policy error
   messages

Call Flow
~~~~~~~~~

.. image:: publish-event-flow.png

Figure - publishAnyEvent Call Flow

Input Parameters
~~~~~~~~~~~~~~~~

Header Fields (note: all parameter names shall be treated as
case-insensitive):

+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Parameter**     | **Data Type**   | **Required?**   | **Brief description**                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Accept            | string          | No              | Determines the format of the body of the response. Valid values are:                                                                                                                                                                                                                                                                                                                                                                                  |
|                   |                 |                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                   |                 |                 | -  application/json                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Authorization     | string          | Yes             | The username and password are formed into one string as “username:password”. This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string “Authorization: Basic “. See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned.   |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Content-length    | integer         | No              | Note that content length is limited to 2Megabyte.                                                                                                                                                                                                                                                                                                                                                                                                     |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Content-type      | string          | Yes             | Must be set to one of the following values:                                                                                                                                                                                                                                                                                                                                                                                                           |
|                   |                 |                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                   |                 |                 | -  application/json                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| X-MinorVersion    | integer         | No              | The minor version of the API requested by the client                                                                                                                                                                                                                                                                                                                                                                                                  |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| X-PatchVersion    | integer         | No              | The patch version of the API requested by the client                                                                                                                                                                                                                                                                                                                                                                                                  |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| X-LatestVersion   | string          | No              | The full version of the API requested by the client expressed as {major}.{minor}.{patch}                                                                                                                                                                                                                                                                                                                                                              |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Body Fields:

+-----------------+-----------------+-----------------+-----------------------------------------------------------+
| **Parameter**   | **Data Type**   | **Required?**   | **Brief description**                                     |
+-----------------+-----------------+-----------------+-----------------------------------------------------------+
| Event           | event           | Yes             | Contains the JSON structure of the common event format.   |
+-----------------+-----------------+-----------------+-----------------------------------------------------------+

Output Parameters
~~~~~~~~~~~~~~~~~

Header fields:

+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| **Parameter**     | **Data Type**   | **Required?**   | **Brief description**                                                      |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| Content-length    | integer         | No              | Used only in error conditions.                                             |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| Content-type      | string          | No              | Used only in error conditions                                              |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| Date              | datetime        | No              | Date time of the response in GMT                                           |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| X-MinorVersion    | integer         | Yes             | The minor version of the API service                                       |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| X-PatchVersion    | integer         | Yes             | The patch version of the API service                                       |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| X-LatestVersion   | string          | Yes             | The full version of the API service expressed as {major}.{minor}.{patch}   |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+

Body Fields (for success responses): no content is provided.

Body Fields (for error responses):

+-----------------+-----------------+--------------------+----------------------------------+
| **Parameter**   | **Data Type**   | **Required?**      | **Brief description**            |
+-----------------+-----------------+--------------------+----------------------------------+
| requestError    | requestError    | Yes (for errors)   | Used only in error conditions.   |
+-----------------+-----------------+--------------------+----------------------------------+

HTTP Status Codes
~~~~~~~~~~~~~~~~~

+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Code*   | *Reason Phrase*         | *Description*                                                                                                                                                                                                                                                                                                                                                                            |
+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+
| 202      | Accepted                | The request has been accepted for processing                                                                                                                                                                                                                                                                                                                                             |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 400      | Bad Request             | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit).   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 401      | Unauthorized            | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details).                                                                                                                                                                                                                               |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 404      | Not Found               | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.                                                                                                                                                                                                                                                   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 405      | Method Not Allowed      | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST).                                                                                                                                                                                                                                     |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500      | Internal Server Error   | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources).                                                                                                                                                                                                                |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Sample Request and Response
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sample Request
^^^^^^^^^^^^^^

+-------------------------------------------------------------------------------+
| POST /eventListener/v7 HTTP/1.1                                               |
|                                                                               |
| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==                             |
|                                                                               |
| content-type: application/json                                                |
|                                                                               |
| content-length: 12345                                                         |
|                                                                               |
| X-MinorVersion: 1                                                             |
|                                                                               |
| {                                                                             |
|                                                                               |
| "event": {                                                                    |
|                                                                               |
|  "commonEventHeader": {                                                       |
|                                                                               |
| "version": "4.1",                                                             |
|                                                                               |
| "vesEventListenerVersion": "7.1",                                             |
|                                                                               |
| "domain": "fault",                                                            |
|                                                                               |
| "eventName": "Fault\_Vscf:Acs-Ericcson\_PilotNumberPoolExhaustion",           |
|                                                                               |
| "eventId": "fault0000245",                                                    |
|                                                                               |
| "sequence": 1,                                                                |
|                                                                               |
| "priority": "High",                                                           |
|                                                                               |
| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",                  |
|                                                                               |
| "reportingEntityName": "ibcx0001vm002oam001",                                 |
|                                                                               |
| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",                           |
|                                                                               |
| "sourceName": "scfx0001vm002cap001",                                          |
|                                                                               |
| "nfVendorName": "Ericsson",                                                   |
|                                                                               |
| "nfNamingCode": "scfx",                                                       |
|                                                                               |
| "nfcNamingCode": "ssc",                                                       |
|                                                                               |
| "startEpochMicrosec": 1413378172000000,                                       |
|                                                                               |
| "lastEpochMicrosec": 1413378172000000,                                        |
|                                                                               |
| "timeZoneOffset": "UTC-05:30"                                                 |
|                                                                               |
| },                                                                            |
|                                                                               |
| "faultFields": {                                                              |
|                                                                               |
| "faultFieldsVersion": 4.0,                                                    |
|                                                                               |
| "alarmCondition": "PilotNumberPoolExhaustion",                                |
|                                                                               |
| "eventSourceType": "other",                                                   |
|                                                                               |
| "specificProblem": "Calls cannot complete - pilot numbers are unavailable",   |
|                                                                               |
| "eventSeverity": "CRITICAL",                                                  |
|                                                                               |
| "vfStatus": "Active",                                                         |
|                                                                               |
| "alarmAdditionalInformation": {                                               |
|                                                                               |
| "PilotNumberPoolSize": "1000"                                                 |
|                                                                               |
| }                                                                             |
|                                                                               |
| }                                                                             |
|                                                                               |
| }                                                                             |
|                                                                               |
| }                                                                             |
+-------------------------------------------------------------------------------+

Sample Success Response
^^^^^^^^^^^^^^^^^^^^^^^

+--------------------------+
| HTTPS/1.1 202 Accepted   |
|                          |
| X-MinorVersion: 1        |
|                          |
| X-PatchVersion: 0        |
|                          |
| X-LatestVersion: 7.1     |
+--------------------------+

Sample Error Responses
^^^^^^^^^^^^^^^^^^^^^^

Sample Policy Exception
'''''''''''''''''''''''

+---------------------------------------------------------------+
| HTTPS/1.1 400 Bad Request                                     |
|                                                               |
| content-type: application/json                                |
|                                                               |
| content-length: 12345                                         |
|                                                               |
| Date: Thu, 04 Jun 2009 02:51:59 GMT                           |
|                                                               |
| X-MinorVersion: 1                                             |
|                                                               |
| X-PatchVersion: 0                                             |
|                                                               |
| X-LatestVersion: 7.1                                          |
|                                                               |
| {                                                             |
|                                                               |
| “requestError”: {                                             |
|                                                               |
| “policyException”: {                                          |
|                                                               |
| “messageId”: “POL9003”,                                       |
|                                                               |
| “text”: “Message content size exceeds the allowable limit”,   |
|                                                               |
| }                                                             |
|                                                               |
| }                                                             |
|                                                               |
| }                                                             |
+---------------------------------------------------------------+

Sample Service Exception
''''''''''''''''''''''''

+-----------------------------------------------------+
| HTTPS/1.1 400 Bad Request                           |
|                                                     |
| content-type: application/json                      |
|                                                     |
| content-length: 12345                               |
|                                                     |
| Date: Thu, 04 Jun 2009 02:51:59 GMT                 |
|                                                     |
| X-MinorVersion: 1                                   |
|                                                     |
| X-PatchVersion: 0                                   |
|                                                     |
| X-LatestVersion: 7.1                                |
|                                                     |
| {                                                   |
|                                                     |
| “requestError”: {                                   |
|                                                     |
| “serviceException”: {                               |
|                                                     |
| “messageId”: “SVC2000”,                             |
|                                                     |
| “text”: “Missing Parameter: %1. Error code is %2”   |
|                                                     |
| “variables”: [                                      |
|                                                     |
| “severity”,                                         |
|                                                     |
| “400”                                               |
|                                                     |
| ]                                                   |
|                                                     |
| }                                                   |
|                                                     |
| }                                                   |
|                                                     |
| }                                                   |
+-----------------------------------------------------+

Operation: publishEventBatch
----------------------------

Functional Behavior
~~~~~~~~~~~~~~~~~~~

Allows authorized clients to publish a batch of events to the VES event
listener.

-  Supports only secure HTTPS (one way SSL) access.

-  Uses the HTTP verb POST

-  Supports JSON content types

-  Provides HTTP response codes as well as Service and Policy error
   messages

Call Flow
~~~~~~~~~

.. image:: publish event flow.png

Figure – publishEventBatch Call Flow

Input Parameters
~~~~~~~~~~~~~~~~

Header Fields (note: all parameter names shall be treated as
case-insensitive):

+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Parameter**     | **Data Type**   | **Required?**   | **Brief description**                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Accept            | string          | No              | Determines the format of the body of the response. Valid values are:                                                                                                                                                                                                                                                                                                                                                                                  |
|                   |                 |                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                   |                 |                 | -  application/json                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Authorization     | string          | Yes             | The username and password are formed into one string as “username:password”. This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string “Authorization: Basic “. See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned.   |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Content-length    | integer         | No              | Note that content length is limited to 2Megabyte.                                                                                                                                                                                                                                                                                                                                                                                                     |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Content-type      | string          | Yes             | Must be set to one of the following values:                                                                                                                                                                                                                                                                                                                                                                                                           |
|                   |                 |                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                   |                 |                 | -  application/json                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| X-MinorVersion    | integer         | No              | The minor version of the API requested by the client                                                                                                                                                                                                                                                                                                                                                                                                  |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| X-PatchVersion    | integer         | No              | The patch version of the API requested by the client                                                                                                                                                                                                                                                                                                                                                                                                  |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| X-LatestVersion   | string          | No              | The full version of the API requested by the client expressed as {major}.{minor}.{patch}                                                                                                                                                                                                                                                                                                                                                              |
+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Body Fields:

+-----------------+-----------------+-----------------+----------------------------------------------------------+
| **Parameter**   | **Data Type**   | **Required?**   | **Brief description**                                    |
+-----------------+-----------------+-----------------+----------------------------------------------------------+
| eventList       | eventList       | Yes             | Array of events conforming to the common event format.   |
+-----------------+-----------------+-----------------+----------------------------------------------------------+

Output Parameters
~~~~~~~~~~~~~~~~~

Header fields:

+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| **Parameter**     | **Data Type**   | **Required?**   | **Brief description**                                                      |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| Content-length    | integer         | No              | Used only in error conditions.                                             |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| Content-type      | string          | No              | Used only in error conditions                                              |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| Date              | datetime        | No              | Date time of the response in GMT                                           |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| X-MinorVersion    | integer         | Yes             | The minor version of the API service                                       |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| X-PatchVersion    | integer         | Yes             | The patch version of the API service                                       |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
| X-LatestVersion   | string          | Yes             | The full version of the API service expressed as {major}.{minor}.{patch}   |
+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+

Body Fields (for success responses: no content is provided.

Body Fields (for error responses):

+-----------------+-----------------+--------------------+----------------------------------+
| **Parameter**   | **Data Type**   | **Required?**      | **Brief description**            |
+-----------------+-----------------+--------------------+----------------------------------+
| requestError    | requestError    | Yes (for errors)   | Used only in error conditions.   |
+-----------------+-----------------+--------------------+----------------------------------+

HTTP Status Codes
~~~~~~~~~~~~~~~~~

+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Code*   | *Reason Phrase*         | *Description*                                                                                                                                                                                                                                                                                                                                                                            |
+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+
| 202      | Accepted                | The request has been accepted for processing                                                                                                                                                                                                                                                                                                                                             |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 400      | Bad Request             | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit).   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 401      | Unauthorized            | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details).                                                                                                                                                                                                                               |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 404      | Not Found               | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.                                                                                                                                                                                                                                                   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 405      | Method Not Allowed      | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST).                                                                                                                                                                                                                                     |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500      | Internal Server Error   | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources).                                                                                                                                                                                                                |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Sample Request and Response
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sample Request
^^^^^^^^^^^^^^

+-------------------------------------------------------------------------------+
| POST /eventListener/v7/eventBatch HTTP/1.1                                    |
|                                                                               |
| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==                             |
|                                                                               |
| content-type: application/json                                                |
|                                                                               |
| | content-length: 12345                                                       |
| | X-MinorVersion: 1                                                           |
|                                                                               |
| {                                                                             |
|                                                                               |
| "eventList": [                                                                |
|                                                                               |
|  {                                                                            |
|                                                                               |
| "commonEventHeader": {                                                        |
|                                                                               |
| "version": "4.1",                                                             |
|                                                                               |
| "vesEventListenerVersion": "7.1",                                             |
|                                                                               |
| "domain": "fault",                                                            |
|                                                                               |
| "eventName": "Fault\_Vscf:Acs-Ericcson\_PilotNumberPoolExhaustion",           |
|                                                                               |
| "eventId": "fault0000250",                                                    |
|                                                                               |
| "sequence": 1,                                                                |
|                                                                               |
| "priority": "High",                                                           |
|                                                                               |
| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",                  |
|                                                                               |
| "reportingEntityName": "ibcx0001vm002oam0011234",                             |
|                                                                               |
| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",                           |
|                                                                               |
| "sourceName": "scfx0001vm002cap001",                                          |
|                                                                               |
| "nfVendorName": "Ericsson",                                                   |
|                                                                               |
| "nfNamingCode": "scfx",                                                       |
|                                                                               |
| "nfcNamingCode": "ssc",                                                       |
|                                                                               |
| "startEpochMicrosec": 1413378172000000,                                       |
|                                                                               |
| "lastEpochMicrosec": 1413378172000000,                                        |
|                                                                               |
| "timeZoneOffset": "UTC-05:30"                                                 |
|                                                                               |
| },                                                                            |
|                                                                               |
| "faultFields": {                                                              |
|                                                                               |
| "faultFieldsVersion": 4.0,                                                    |
|                                                                               |
| "alarmCondition": "PilotNumberPoolExhaustion",                                |
|                                                                               |
| "eventSourceType": "other",                                                   |
|                                                                               |
| "specificProblem": "Calls cannot complete - pilot numbers are unavailable",   |
|                                                                               |
| "eventSeverity": "CRITICAL",                                                  |
|                                                                               |
| "vfStatus": "Active",                                                         |
|                                                                               |
| "alarmAdditionalInformation": {                                               |
|                                                                               |
| "PilotNumberPoolSize": "1000"                                                 |
|                                                                               |
| }                                                                             |
|                                                                               |
| }                                                                             |
|                                                                               |
| },                                                                            |
|                                                                               |
| {                                                                             |
|                                                                               |
| "commonEventHeader": {                                                        |
|                                                                               |
| "version": "4.1",                                                             |
|                                                                               |
| "vesEventListenerVersion": "7.1",                                             |
|                                                                               |
| "domain": "fault",                                                            |
|                                                                               |
| "eventName": " Fault\_Vscf:Acs-Ericcson\_RecordingServerUnreachable",         |
|                                                                               |
| "eventId": "fault0000251",                                                    |
|                                                                               |
| "sequence": 0,                                                                |
|                                                                               |
| "priority": "High",                                                           |
|                                                                               |
| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",                  |
|                                                                               |
| "reportingEntityName": "ibcx0001vm002oam0011234",                             |
|                                                                               |
| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",                           |
|                                                                               |
| "sourceName": "scfx0001vm002cap001",                                          |
|                                                                               |
| "nfVendorName": "Ericsson",                                                   |
|                                                                               |
| "nfNamingCode": "scfx",                                                       |
|                                                                               |
| "nfcNamingCode": "ssc",                                                       |
|                                                                               |
| "startEpochMicrosec": 1413378172000010,                                       |
|                                                                               |
| "lastEpochMicrosec": 1413378172000010,                                        |
|                                                                               |
| "timeZoneOffset": "UTC-05:30"                                                 |
|                                                                               |
| },                                                                            |
|                                                                               |
| "faultFields": {                                                              |
|                                                                               |
| "faultFieldsVersion": 4.0,                                                    |
|                                                                               |
| "alarmCondition": "RecordingServerUnreachable",                               |
|                                                                               |
| "eventSourceType": "other",                                                   |
|                                                                               |
| "specificProblem": "Recording server unreachable",                            |
|                                                                               |
| "eventSeverity": "CRITICAL",                                                  |
|                                                                               |
| "vfStatus": "Active"                                                          |
|                                                                               |
| }                                                                             |
|                                                                               |
| }                                                                             |
|                                                                               |
| ]                                                                             |
|                                                                               |
| }                                                                             |
+-------------------------------------------------------------------------------+

Sample Success Response
^^^^^^^^^^^^^^^^^^^^^^^

+--------------------------+
| HTTPS/1.1 202 Accepted   |
|                          |
| X-MinorVersion: 1        |
|                          |
| X-PatchVersion: 0        |
|                          |
| X-LatestVersion: 7.1     |
+--------------------------+

Sample Error Responses
^^^^^^^^^^^^^^^^^^^^^^

Sample Policy Exception
'''''''''''''''''''''''

+---------------------------------------------------------------+
| HTTPS/1.1 400 Bad Request                                     |
|                                                               |
| content-type: application/json                                |
|                                                               |
| content-length: 12345                                         |
|                                                               |
| Date: Thu, 04 Jun 2009 02:51:59 GMT                           |
|                                                               |
| X-MinorVersion: 1                                             |
|                                                               |
| X-PatchVersion: 0                                             |
|                                                               |
| X-LatestVersion: 7.1                                          |
|                                                               |
| {                                                             |
|                                                               |
| “requestError”: {                                             |
|                                                               |
| “policyException”: {                                          |
|                                                               |
| “messageId”: “POL9003”,                                       |
|                                                               |
| “text”: “Message content size exceeds the allowable limit”,   |
|                                                               |
| }                                                             |
|                                                               |
| }                                                             |
|                                                               |
| }                                                             |
+---------------------------------------------------------------+

Sample Service Exception
''''''''''''''''''''''''

+-----------------------------------------------------+
| HTTPS/1.1 400 Bad Request                           |
|                                                     |
| content-type: application/json                      |
|                                                     |
| content-length: 12345                               |
|                                                     |
| Date: Thu, 04 Jun 2009 02:51:59 GMT                 |
|                                                     |
| X-MinorVersion: 1                                   |
|                                                     |
| X-PatchVersion: 0                                   |
|                                                     |
| X-LatestVersion: 7.1                                |
|                                                     |
| {                                                   |
|                                                     |
| “requestError”: {                                   |
|                                                     |
| “serviceException”: {                               |
|                                                     |
| “messageId”: “SVC2000”,                             |
|                                                     |
| “text”: “Missing Parameter: %1. Error code is %2”   |
|                                                     |
| “variables”: [                                      |
|                                                     |
| “severity”,                                         |
|                                                     |
| “400”                                               |
|                                                     |
| ]                                                   |
|                                                     |
| }                                                   |
|                                                     |
| }                                                   |
|                                                     |
| }                                                   |
+-----------------------------------------------------+

Terminology
===========

Terminology used in this document is summarized below:

**A&AI**. Active & Available Inventory is the ONAP component that
provides data views of Customer Subscriptions, Products, Services,
Resources, and their relationships.

**Alarm Condition**. Short name of the alarm condition/problem, such as
a trap name.

**APPC (formerly APP-C)**. Application Controller. Handles the life
cycle management of Virtual Network Functions (VNFs).

**ASDC**. AT&T Service Design and Creation Platform: the original name
for the SDC. Replaced by SDC.

**Common Event Format**. A JSON schema describing events sent to the VES
Event Listener.

**Common Event Header**. A component of the Common Event Format JSON
structure. This datatype consists of fields common to all events.

**DCAE**. Data Collection Analysis and Events. DCAE is the ONAP
subsystem that supports closed loop control and higher-level correlation
for business and operations activities. DCAE collects performance,
usage, and configuration data, provides computation of analytics, aids
in trouble-shooting and management, and publishes event, data, and
analytics to the rest of the ONAP system for FCAPS functionality.

**DMaaP.** Data Movement as a Platform. A set of common services
provided by ONAP, including a Message Router, Data Router, and a Data
Bus Controller.

**Domain**. In VES, an event ‘domain’ identifies a broad category of
events (e.g., ‘fault’ or ‘measurement’), each of which is associated
with a VES domain field block, which is sent with the commonEventHeader
when events of that category are generated.

**ECOMP**. Enhanced Control, Orchestration, Management and Policy
preceded ONAP and is the name given to AT&T’s instance of the ONAP
platform.

**Epoch**. The number of seconds that have elapsed since
00:00:00 \ `Coordinated Universal
Time <https://en.wikipedia.org/wiki/Coordinated_Universal_Time>`__ (UTC),
Thursday, 1 January 1970. Every day is treated as if it contains exactly
86400 seconds, so \ `leap
seconds <https://en.wikipedia.org/wiki/Leap_second>`__ are not applied
to seconds since the Epoch. In VES Epoch times are measured in
microseconds.

**Event.** A well-structured packet of network management information
identified by an eventName which is asynchronously communicated to one
or more instances of an Event Listener service to subscribers interested
in that eventName. Events can convey measurements, faults, syslogs,
threshold crossing alerts, and others types of information.

**Event Id**. Event key that is unique to the event source. The key must
be unique within notification life cycle similar to EventID from 3GPP.
It could be a sequential number, or a composite key formed from the
event fields, such as sourceName\_alarmCondition\_startEpoch. The
eventId should not include whitespace. For fault events, eventId is the
eventId of the initial alarm; if the same alarm is raised again for
changed, acknowledged or cleared cases, eventId must be the same as the
initial alarm (along with the same startEpochMicrosec and an incremental
sequence number.

**Event Name**. Identifier for specific types of events. Specific
eventNames registered by the YAML may require that certain fields, which
are optional in the Common Event Format, be present when events with
that eventName are published.

**Event Streaming**. The delivery of network management event
information in real time.

**Extensible Data Structures**. Data structures (e.g., hashMap) that
allow event sources to send information not specifically identified in
the VES schema.

**Hash Map**. A hash table, or data structure, used to implement an
associative array, a structure than can map keys to values. In VES 6.0,
all name-value pair structures were changed to hash maps (i.e., {‘name’:
‘keyName’, ‘value’: ‘keyValue’} was replaced with {‘keyName’:
‘keyValue’}).

**ICE**. Incubation and Certification Environment. Facilitates vendors
and third-party in developing virtual network functions using ONAP and a
network cloud.

**IPMI**. The `Intelligent Platform Management
Interface <https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface>`__.

**JSON**. Java Script Object Notation. JSON is an
`open-standard <https://en.wikipedia.org/wiki/Open_standard>`__ `file
format <https://en.wikipedia.org/wiki/File_format>`__ that uses
`human-readable <https://en.wikipedia.org/wiki/Human-readable_medium>`__
text to transmit data objects consisting of `attribute–value
pairs <https://en.wikipedia.org/wiki/Attribute%E2%80%93value_pair>`__
and `array data types <https://en.wikipedia.org/wiki/Array_data_type>`__
(or any other
`serializable <https://en.wikipedia.org/wiki/Serialization>`__ value).
It is a very common `data <https://en.wikipedia.org/wiki/Data>`__ format
used for
`asynchronous <https://en.wikipedia.org/wiki/Asynchronous_I/O>`__
browser–server communication.

**NF**. Network Function. Generalized name for a VNF or PNF.

**NFC**. Network Function Component. Generalized name for a VNFC or a
component of a PNF.

**ONAP**. `Open Network Automation Platform <https://www.onap.org/>`__.

**PNF**. Physical Network Function.

**Policy**. Course of action for the management of the network. The ONAP
Policy Framework is a comprehensive policy design, deployment, and
execution environment. The Policy Framework is the ***decision making***
component in `an ONAP
system <https://www.onap.org/wp-content/uploads/sites/20/2017/12/ONAP_CaseSolution_Architecture_120817_FNL.pdf>`__.
It allows you to specify, deploy, and execute the governance of the
features and functions in your ONAP system, be they closed loop,
orchestration, or more traditional open loop use case implementations.
The Policy Framework is the component that is the source of truth for
all policy decisions.

**Reporting Entity Name**. Name of the entity reporting the event or
detecting a problem in another vnf/vm or pnf which is experiencing the
problem. May be the same as the sourceName. Not used for performance
measurements currently.

**SDC**. Service Design and Creation Platform: The ONAP visual modeling
and design tool. It creates internal metadata that describes assets used
by all ONAP components, both at design time and run time. The SDC
manages the content of a catalog, and assemblies of selected catalog to
define how and when VNFs are realized in a target environment.  

**Source Name**: Name of the entity experiencing the event issue, which
may be detected and reported by a separate reporting entity. The
sourceName identifies the device for which data is collected. A valid
sourceName must be inventoried in A&AI.

**Specific Problem**. Description of the alarm or problem.

**VES**. Virtual Function Event Stream. In 6.0, the definition of VES
was expanded to include event streaming for VNF, PNF and infrastructure.
The VES Event Listener can receive any event sent in the VES Common
Event Format.

**VES Event Listener**. A RESTful connectionless push event listener
capable of receiving single events or batches of events sent in the
Common Event Format.

**VM**. Virtual Machine.

**VNF**. Virtual Network Function. A VNF is a virtualized task formerly
carried out by proprietary, dedicated network hardware. (Examples:
virtual firewall, virtual DNS). A VNF can also be defined as a specific
kind of Vendor Software Product.

**YAML**. A `data serialization
language <https://en.wikipedia.org/wiki/Data_serialization_language>`__
and superset of JSON.

**VNFC**. Virtual Network Function Component. A VNFC is a part of a VNF.
It is a stand-alone executable that is loosely-coupled, granular,
re-usable, and responsible for a single capability.

Appendix: Historical Change Log
===============================

For the latest changes, see the Change Block just before the Table of
Contents.

+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Date         | Revision   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 5/22/2015    | 0.1        | Initial Release - Draft                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 5/29/2015    | 0.2        | -  Introduction: removed all system names and references to internal AT&T components                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Security: changed ‘event publisher’ to ‘event source’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Generic Event Format: updated the JSON schema per the below:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  eventHeader: clarified the description of id, made sourceId a required field, changed the datatype of timestamps to timestamp [ ]                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  performanceFields: removed overflowFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  tmestamp: added a description of this datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Exceptions: fixed indentation of sections                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Approvers: updated the list of approvers and added attuids                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 6/3/2015     | 0.3        | -  Updated the security section to use HTTP Basic Authentication per AT&T REST standards. Updated the input parameters and messaging examples to use the new security scheme.                                                                                                                                                                                                                                                                                                                                                                          |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 6/5/2015     | 0.4        | -  Added otherFields sub section to the defined datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Added locale field to the eventHeader.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 6/5/2015     | 0.5        | -  Updated the embedded event format json schema to match the changes made in v0.4                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 6/10/2015    | 0.6        | -  Updated the {ServerRoot} format to contain an optional routing path (for D2 service modules).                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 7/7/2015     | 0.7        |     Common Event Format updates:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  EventHeader: added ‘measurement’ to the ‘domain’ enumeration; changed ‘locale’ to ‘location’ and clarified in the description that this should be a clli code                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Added a MeasurementFields datatype, which required the addition of the following datatypes: codecsInUse, cpuUsage, diskUsage, featuresInUse, memoryUsage                                                                                                                                                                                                                                                                                                                                                                                            |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 7/15/2015    | 1.0        | -  Changed sourceInstance in the eventHeader to be an array of name value pairs                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Changed the performanceFields block to thresholdCrossingAlertFields. Updated the domain field of the eventHeader to match.                                                                                                                                                                                                                                                                                                                                                                                                                          |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 7/23/2015    | v1.1       |     Changes to eventHeader data format:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  moved sourceInstance to internalHeaderFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  moved serviceInstanceId to internalHeaderFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  moved productId to internalHeaderFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  moved subscriberId to internalHeaderFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  moved location to internalHeaderFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  added the following new fields in internalHeaderFields: policyType, policyName, correlationEventType, correlationType, correlationName, correlationRootEventId                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Changes to faultFields data format:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  moved the eventSourceDeviceDescription to internalFaultFields and renamed it equipmentVendorModel                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  moved eventSourceHostname to internalFaultFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  changed alarmObjectInterface to alarmInterfaceA                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  changed alarmRemoteObject to alarmRemoteObjectZ and moved it to internalFaultFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  changed alarmRemoteObjectInterface to alarmInterfaceZ and moved it to internalFaultFields                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Changes to thresholdCrossingFields data format:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  changed several references from the old ‘performanceFields’ block to the new ‘thresholdCrossingFields’ block                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Other:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fixed several comma and colon syntax errors in the JSON schema as detected by a JSON schema syntax checker.                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 8/11/2015    | v1.2       |     Timestamp format:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.18: added a note in the datetime field of the Timestamp datatype specifying the (GMT) format required                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Updated the JSON schema with the same information                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |     Event Header Severity Enumeration:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.8: modified the severity enumeration to remove the numbers in parentheses that followed the names. The names were not changed.                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Updated the JSON schema with the same information.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 8/20/2015    | v1.3       | JSON Schema rev’d to v9:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Alphabetized all fields in the JSON schema                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fixed the way arrays were specified (JSON schema syntax issue)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | Sample Responses:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  2.1.1.1: alphabetized fields, fixed timestamps array depiction, fixed severity enum value to conform to latest format                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  6.2.6.1: alphabetized fields, fixed timestamps array depiction, fixed severity enum value to conform to latest format                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  6.3.6.1: alphabetized fields, fixed timestamps array depiction, fixed severity enum value to conform to latest format                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  6.4.6.1: alphabetized fields, fixed timestamps array depiction, fixed eventList array depection, fixed severity enum value to conform to latest format                                                                                                                                                                                                                                                                                                                                                                                              |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 9/16/2015    | v1.4       | JSON Schema rev’d to v10:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fixed an error in the way that the top level “event” object was specified in the v9 json schema. This was discovered when validating examples against the schema using this site: http://json-schema-validator.herokuapp.com/index.jsp.                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Changed the embedded json file in section 4                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | Sample Responses:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Removed an extra comma after the timestamp brace in section 6.2.6 and 6.3.6.                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 11/11/2015   | v1.5       | Section 4 was the only section changed: JSON Schema rev’d to v11 and Datatype tables were updated to match. Numerous data structure changes were made based on VNF vendor proof of concept feedback. Modified sample requests and responses to match.                                                                                                                                                                                                                                                                                                  |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 11/12/2015   | v1.6       | -  The internalFaultFields were merged into the internalHeaderFields; then the internalFaultFields datatype was deleted.                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Updated the JSON schema to v12.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Also corrected some background color issues in the sample requests and responses.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 1/18/2016    | v1.7       | -  Section 2 changes: updated the sample request to conform with the changes below                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4 datatype changes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Changed 'eventHeader' to 'commonEventHeader'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Moved 'eventSeverity' from the 'commonEventHeader' to 'faultFields'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Added 'priority' to 'commonEventHeader'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  moved 'vFstatus' to 'faultFields'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  removed 'firstDateTime' and 'lastDateTime' and changed 'firstEpoch' to 'startEpochMicrosec' and changed 'lastEpoch' to 'lastEpochMicrosec'.                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Added 'functionalRole' to the commonEventHeader                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  In the commonEventHeader, changed the 'eventDomain' enumeration to remove 'measurements' and add 'measurementsForVfScaling'.                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Changed the 'measurementFields' to 'measurementsForVfScalingFields'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  In the commonEventHeader, changed the following fields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  'eventDomain' to 'domain'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  'eventSequence' to 'sequence'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  'eventSourceId' to 'sourceId'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  'eventSounceName' to 'sourceName'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Updated the JSON schema to v13                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6 changes: updated the input parameters and sample requests to conform to the changes above.                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 7: changed the section from Approvers to Contributors.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 1/22/2016    | v1.8       | -  Section 4: Added support for ‘mobileFlow’ in the commonEventHeader ‘domain’ enumeration. Added the mobileFlowFields datatype and the gtpPerFlowMetrics datatype referenced by that datatype.                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 7: alphabetized the contributors                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2/11/2016    | v1.9       | -  Added section 1.3: Naming Standard for Event Types                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2/12/2016    | v2.0       | -  Updated request – response examples to reflect the naming standards for event types introduced in v1.9.                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Added a paragraph on use of Avro as a transport in section 1.4                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3/11/2016    | v2.1       | -  Updated the embedded JSON schema to v15 to fix a typo in the required fields for the measurementsForVfScalingFields, namely, changed ‘configuredEntites’ to ‘configuredEntities’. Additionally, added an ‘Event Listener’ title block at the bottom of the file with a single required event object.                                                                                                                                                                                                                                                |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3/15/2016    | v2.2       | -  Added mobileFlowFields to the event datatype definition in section 4.7 and updated the embedded json schema at the top of section 4 to v16.                                                                                                                                                                                                                                                                                                                                                                                                         |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 4/26/2016    | v2.3       | -  Generic Event Format updates: 1) made ‘priority’ lowercase in the Word doc table for commonEventHeader; 2) added ‘requestError’ data structure to the Word doc and JSON schema (which is now at v17)                                                                                                                                                                                                                                                                                                                                                |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 4/27/2016    | v2.4       | -  JSON Schema: In the 'event' data structure, changed 'thresholdCrossingFields' to 'thresholdCrossingAlertFields' to product v18 of the schema.                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  'codecsInUse' data structure: changed 'numberInUse' to 'codecUtilization’                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 5/26/2016    | v2.5       | -  Changed responses from ‘204 No Content’ to ‘202 Accepted’ and added a body to the response that enable AT&T to throttle the events being sent and/or to request the current state of throttling at the event source.                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Added new datatypes to support the above: eventDomainThrottleSpecification, eventDomainThrottleSpecificationList, eventThrottlingState, suppressedNvPairs                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Modifed the commonEventFormat json schema to v19                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Note: for the VendorEventListener: added new licensing language on the back of the title page; added an “attCopyrightNotice” definition at the top of the commonEventFormat\_Vendors.json file; also removed all references to internalHeaderFields from this file and from the VendorEventListener spec.                                                                                                                                                                                                                                           |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 8/9/2016     | v2.6       | -  commonHeader: added a note on the description of sourceId and sourceName in the commonHeader: "use reportingEntity for domains that provide more detailed source info"                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  commonHeader: deleted the capacity, measurementsForVfScaling and usage domains in the domain enumeration                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  commonHeader: added the following domains to the domain enumeration: licensingKci, scalingKpi, stateChange                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  event: removed references to capacityFields, measurementsForVfScalingFields and usageFields and added references to licensingKciFields, scalingKpiFields, stateChangeFields                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  licensingKciFields: added this section along with 'additionalMeasurements', which is an optional list of measurementGroup structures. Changed the name of kciFieldsVersion to licensingKciFieldsVersion.                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  scalingKpiFields: added this section but changed measurementFieldsVersion to scalingKpiFieldsVersion                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  stateChangeFields: added this section along with 'additionalFields', which is an optional list of name-value pairs. Other fields included newState and oldState which were enumerations of the following possible states: 'inService', 'maintenance', 'outOfService'                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  sysLogFields: added 'additionalFields', which is an optional list of name-value pairs                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  vNicUsage: added two required fields to the vNicUsage data structure: packetsIn and packetsOut                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 8/10/2016    | v2.7       | -  commonHeader: removed the note on the description of sourceId and sourceName in the commonHeader: "use reportingEntity for domains that provide more detailed source info"                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  commonHeader: added measurementsForVfScaling domain back and removed the licensingKci and scalingKpi domains                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  event: removed references to licensingKciFields and scalingKpiFields; added references to measurementsForVfScalingFields                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  measurementsForVfScalingFields: combined the kciDetail and kpiDetail structures into the measurementsForVfScalingFields structure; referenced the errors structure                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  errors: added a new structure to capture the receive and transmit errors for the measurements domain                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  removed the following structures: kci, kpi, scalingKpiFields and licensingKciFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  eventDomainThrottleSpecification: updated the reference to commonEventHeader domain field                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  faultFields: removed the numbers from the enumerated strings for eventSourceType                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  vNicUsage: made the broadcast, multicast and unicast fields optional                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  contributors: updated Alok’s organizational area                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 8/12/2016    | v2.8       | -  commonHeader: copied the descriptions of sourceId and sourceName from the JSON schema into the word document tables.                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  sample request examples: moved the reportingEntityId and reportingEntityNames to the same relative place in all sample requests in the document                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fixed the sample request shown for publishEventBatch to take an eventList as input.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fixed the sample request shown for publishSpecificTopic to put the topic in the URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  errors: changed the receiveErrors and transmitErrors fields to be datatype number                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  codesInUse: changed 'codecUtilization' to 'numberinUse'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  vNicUsage: updated the description of the fields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 8/27/2016    | v2.9       | -  Added a note "(currently: 1.1)" in the descriptions of the following fields: commonEventHeader:version, faultFields:faultFieldsVersion, measurementsForVfScalingFields:measurementsForVfScalingFieldsVersion, stateChangeFields:stateChangeFieldsVersion, sysLogFields:syslogFieldsVersion, thresholdCrossingAlertFields:thresholdCrossingFieldsVersion                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  stateChangeFields: made stateInterface mandatory                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  changed 'enum' to 'enumeration' throughout section 4 of the document (note: this can't be done in the JSON schema).                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  measurementsForVfScalingFields: made the following fields optional: conurrentSessions, configuredEntitites, cpuUsageArray, fileSystemUsageArray, memoryConfigured, memoryUsed, requestRate, vNicUsageArray                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  measurementsForVfScalingFields: concurrentSessions and configuredEntities: changed the description to support both VMs and VNFs                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  measurementsFor VfScalingFields: clarified the descriptions of latencyDistribution, measurementInverval and requestRate                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  syslogFields: clarified the descriptions of syslogSData, syslogTag, syslogVer                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  thresholdCrossingAlertFields: made the following fields optional and clarified their descriptions: elementType, networkService                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  command and commandList: created a list of command structures to enable the event collector to request changes of event sources. Commands consist of a commandType along with optional fields (whose presence is indicated by the commandType). Three command types are currently supported: 'measurementIntevalChange', ‘provideThrottlingState’ and 'throttlingSpecification'.                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  eventDomainThrottleSpecificationList: removed this and replaced it with commandList.                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Operations and Sample Requests: modified the operations and samples to support the new command and commandList structures.                                                                                                                                                                                                                                                                                                                                                                                                                          |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 9/1/2016     | v2.10      | -  measurementsForVfScaling block: made the following fields optional: latencyDistribution (which is an array of latencyBucketMeasure structures) and meanRequestLatency. Updated the JSON schemas (now v24) to match.                                                                                                                                                                                                                                                                                                                                 |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 9/16/2016    | v2.11      | -  1 Introduction: updated the introduction to clarify the usage of eventTypes and the possibility of support for other protocols.                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  6.1 REST Operation Overview: added two new subsections (6.1.2 and 6.1.3) discussing Api Version and Commands Toward Event Source Clients.                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  6.2 publishAnyEvent: fixed the sample to conform to the latest changes                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  6.3 publishSpecificTopic: fixed the sample to conform to the latest changes                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  6.4 publishEventBatch: fixed the sample to conform to the latest changes                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  6.5 provideThrottlingState operation: added the Input Parameters section heading back and fixed the sample request to provide eventThrottlingState (instead of eventThrottlingClientState).                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  The remaining bullets describe changes made to section 4 datatypes in alphabetical order:                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  command datatype: referenced the new section 6.1.3 which provides an explanation of command state expectations and requirements for a given eventSource:                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  commonEventHeader datatype:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  made sourceId and reportingEntityId fields optional (although the internal Generic Event Listener spec indicates, in the field descriptions, that the AT&T enrichment process shall ensure that these fields are populated)                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  domain enumeration: changed measurementsForVfScalingFields to measurementsForVfScaling                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  eventDomainThrottleSpecificationList: added this array of eventDomainThrottleSpecification stuctures back to the schema because it is used by the provideThrottlingState operation.                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  eventList: added eventList back to the vendor version of the commonEventFormat. This is used by the publishEventBatch operation.                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  faultFields datatype:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  eventSourceType: made this a string (and provided the previous enumerated values as examples)                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  filesystemUsage datatype:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  changed vmIdentifier to filesystemName                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  gtpPerFlowMetrics datatype:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  flowActivationTime: changed the format and description to be compliant with RFC 2822.                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  flowDeactivationTime: changed the format and description to be compliant with RFC 2822.                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  internalHeaderFields datatype:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added the following optional fields: firstDateTime, lastDateTime compliant with RFC 2822. Noted in the description that these fields must be supplied for events in the following domains: fault, thresholdCrossingAlerts and measurementsForVfScaling.                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  ticketingTimestamp: changed the format and description to be compliant with RFC 2822.                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  syslogFields datatype:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  eventSourceType: made this a string (and provided the previous enumerated values, without the numbers, as examples)                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  thresholdCrossingAlerts dataypte:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  collectionTimestamp: changed the format and description to be compliant with RFC 2822.                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  eventStartTimestamp: changed the format and description to be compliant with RFC 2822.                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added the same eventSeverity field as from the faultFields and made it required                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 9/23/2016    | v2.12      | -  Section 4 Datatypes: commonEventHeader: made reportingEntityName a required field (note: the JSON schema already had this field as required)                                                                                                                                                                                                                                                                                                                                                                                                        |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 11/29/2016   | v3.0       | -  Introduction:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Introductory paragraph: changed '...Common Event Header Block followed by zero or more event domain blocks' to '...Common Event Header Block accompanied by zero or more event domain blocks' since the order of the blocks on the wire is not guaranteed.                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added Section 1.5 Versioning                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: codec processing:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  CommonEventFormat\_Vendors schema only: codesInUse: changed required field from "codecUtilization" which was removed previously to "numberInUse" which is the new field name.                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added ‘codecSelected’ datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added ‘codecSelectedTranscoding’ datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4 and section 6: command processing:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added commandListEntry which is an object that references the command object.                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  commandList: changed commandList to contain an array of commandListEntry objects.                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Updated sample responses in section 6 where commands are used                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: commonEventHeader:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Incremented version to 1.2                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added two new values to the ‘domain’ enumeration: ‘serviceEvents’ and ‘signaling                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: added endOfCallVqmSummaries datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: ‘event’: added two fields: ‘serviceEventsFields’ and ‘signalingFields’                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: added ‘eventInstanceIdentifier’datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: CommonEventListener only: internalHeaderFields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added ‘internalHeaderFieldsVersion’(initially set to 1.1)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added ‘correlationFirstEpoch’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added 'closedLoopControlName'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added 'closedLoopFlag'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added 'collectorTimeStamp'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added 'eventTag'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added ‘tenantName’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  changed 'operationalStatus' to 'inMaint'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added required fields in the schema to match the word doc: 'equipmentNameCode', 'equipmentType', 'equipmentVendor', 'inMaint', 'provStatus'                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: added ‘marker’datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: added ‘midCallRtcp’ datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: mobileFlowFields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added ‘mobileFlowFieldsVersion’(initially set to 1.1)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: added ‘serviceEventsFields’datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: added ‘signalingFields’ datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: syslogFields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Incremented syslogFieldsVersion to 1.2                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added 'syslogPri'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added 'syslogSev'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added ‘syslogSdId’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: thresholdCrossingAlertFields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Incremented thresholdCrossingFieldsVersion to 1.2                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added 'additionalFields' which is an optional list of name value pairs.                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: schema v26.0 embedded reflecting the above changes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6 and Section 2: changed all sample requests to use /v3 in the REST Resource URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 12/1/2016    | v3.1       | -  Section 6: Updated the call flow diagrams to show ‘v3’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 1/5/2017     | v4.0       | -  Combined the Generic Event Listener and Vendor Event Listener into a single API service specification with version 4.0.                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Changed the title to VES (Virtual Function Event Streaming) Listener.                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Changed references to 'generic event' to 'common event' or 'VES event' (depending on the context) throughout the document.                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Used the Legal Disclaimer from the Vendor Event Listener on the back of the title page.                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 1: Introduction changes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  modified wording to reference 'VES'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  removed the 'Audience' section, which described various AT&T groups the documented was intended for                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  tweaked the naming standards for event types to clarify the purpose of the naming conventions                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 3: Resource Structure: added a sentence describing the FQDN and port used in the resource URL.                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: Common Event Format changes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  renamed the section to 'Common Event Format' from 'Generic Event Format'                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  reorganized the datatypes into separate sections; sections were defined for each of the domains as well as for common event, common event header and command list processing                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  codecSelected datatype: removed this datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  codecSelectedTranscoding datatype: removed this datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  command datatype: added an enumerated value to commandType: 'heartbeatIntervalChange'                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  commonEventHeader: added internalHeaderFields to the commonEventHeader, defined as "Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each provider implementing the VES Event Listener."                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  commonEventHeader: removed two enumerated values, 'serviceEvents' and 'signaling' from the domain enumeration                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  commonEventHeader version: incremented the version to 2.0                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  endOfCallVqmSummaries datatype: removed this datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  event: changed the description of the event datatype to: "fields which constitute the ‘root level’ of the common event format"                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  event: removed 'serviceEventFields' and 'signalingFields' from the definition                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  event: fixed a misspelling of ‘thresholdCrossingAlertFields’, which was only present in the Word document                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  eventInstanceIdentifier datatype: removed this datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  internalHeaderFIelds datatype: defined this as follows: "The internalHeaderFields datatype is an undefined object which can contain arbitrarily complex JSON structures. It is intended to be defined separately by each provider implementing the VES Event Listener. The fields in internalHeaderFields are not provided by any event source but instead are added by the VES Event Listener service itself as part of an event enrichment process necessary for efficient internal processing of events received by the VES Event Listener"   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  marker datatype: removed this datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  measurementsForVfScalingFields datatype: clarified that memoryConfigured and memoryUsed are measured in MB                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  midCallRtcp datatype: removed this datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  mobileFlowFields datatype: added ‘additionalFields’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  mobileFlowFields datatype: incremented the version number for this field block to 1.2                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  serviceEventsFields datatype: removed this datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  signalingFields datatype: removed this datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  syslogFields: added three fields to the schema that were previously described in the document but not incorporated into the schema: syslogPri, syslogSev, syslogSdId                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  syslogFields version: incremented the version to 2.0                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Modified the Common Event Format JSON schema to v27.0 to incorporate the above changes. Also, added the AT&T Copyright Notice from the top of the retired CommonEventFormat\_Vendors schema.                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6 and 2: changed all sample requests to use /v4 in the REST Resource URL and call flow diagrams.                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.1.3: added a row to the table in this section describing the ‘heartbeatIntervalChange’ command.                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.1.4: added this new section describing expectations for buffering of events should all REST resource URL FQDNs be unreachable.                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6 Sample Requests: modified all sample requests showing the return of a commandList toward the event source to incorporate a heartbeatIntervalChange command; also corrected the spelling in the samples for the measurementIntervalChange command.                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 7: Contributors: removed this section                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3/21/2017    | v4.1       | -  JSON Schema changes to produce v27.2 (note: an earlier draft version of v27.1 had been distributed to a few individuals):                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  To support use of the schema with event batches, removed the following statement near the end of the schema file:                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |     “required”: [ “event” ]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fixed the characters used in some of the quotes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fixed some typos in the descriptions.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Removed the booleans, which were non-essential and which were causing problems across different implementations.                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.5.7 measurementsForVfScalingFields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Fixed the spelling of measurementsForVfScalingFields in the Word document                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 2 and 6 sample requests and responses:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Removed quotes from numbers: sequence, and first/lastEpochMicrosec.                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Fixed all quote characters, some of which were using unusual symbols that wouldn’t validate with the json-schema Python package.                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.2.6.1, 6.3.6.1, 6.4.6.1 sample requests:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added an alarmAdditionalInformation field array to the sample requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added missing commas.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.5.6.1 provideThrottlingState sample requests:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Fixed the eventDomainThrottleSpecificationList to pass an array of anonymous eventDomainThrottleSpecification objects.                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added missing quotes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fixed the suppressedNvPairsList to pass an array of anonymous suppressedNvPairs objects.                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 4/14/2017    | v5.0       | -  Section 1 Introduction:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Clarified the Introduction (Section 1).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed Section 1.1 title from ‘Terminology’ to 'Event Registration' and referenced the YAML event registration format, defined in a separate document.                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Clarified naming standards for eventName.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 3: updated the REST resource structure                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.1 command list processing datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Got rid of commandListEntry and returned commandList to a simple array of commands.                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added heartbeatInterval to the command datatype.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed the datatype of measurementInterval from number to integer.                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.2 common event datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  event dataType: Added heartbeatFields, sipSignalingFields and voiceQualityFields to the event datatype as optional field blocks                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added jsonObject which provides a json object schema, name and other meta-information along with one or more object instances.                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added jsonObjectInstance which provides meta-information about an instance of a jsonObject along with the actual object instance                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added the ‘key’ datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added the namedArrayOfFields datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added vendorVnfNameFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.3 common event header fields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Add two new enumerations to domain: ‘sipSignaling’ and ‘voiceQuality’                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Renamed eventType to eventName. Note that the original usage of eventType was formally described in the Introduction back on 2/11/2016 with v1.9.                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Made eventName a required field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Created a new field called eventType with a meaning that is different than the old eventType.                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Removed functionalRole, which was replaced by the following two fields.                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added nfNamingCode                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added nfcNamingCode                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed version to 3.0 (major version change) and made it a required field                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.4: faultFields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added one optional field: eventCategory                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  made faultFieldsVersion a required field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  changed faultFieldsVersion to 2.0 (major version change)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  fixed a typo on the spelling of alarmInterfaceA                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  clarified field descriptions                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.5: added heartbeatFields datatype which can be used to communicate heartbeatInterval. Note: this change was previously made in v4.2                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.6 measurements for vf scaling datatypes: changed the following datatypes from number to integer:                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  In measurementsForVfScalingFields: concurrentSessions, configuredEntities, numberOfMediaPortsInUse, vnfcScalingMetric                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  In codecsInUse: numberInUse                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  In featuresInUse: featureUtilization                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.6.2 modified cpuUsage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.6.3 added diskUsage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.6.7 measurementsForVfScalingFields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  fixed the spelling of the measurementsForVfScalingFields in the Word document                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added additionalFields, which is an array of fields (i.e., name-value pairs)                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  changed additionalMeasurements to reference the common datatype namedArrayOfFields (instead of referencing measurementGroup)                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added additionalObjects which is an array of jsonObjects described by name, keys and schema                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  deleted aggregateCpuUsage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added diskUsageArray                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  deleted measurementGroup (which was replaced by the common datatype: namedArrayOfFields                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added memoryUsageArray                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  deleted memoryConfigured and memoryUsed                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  deleted errors and vNicUsageArray                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added vNicPerformanceArray                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  changed the measurementsForVfScalingVersion to 2.0 (major version change) and made it a required field. Also changed the name of this version field in the Word document to match that in the JSON schema.                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.6.8 added memoryUsage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.6.9 vNicPerformance: replaced vNicUsage and errors with vNicPerformance                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.7 mobile flow fields changes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Made mobileFlowFieldsVersion a required field and changed the mobileFlowFieldsVersion to 2.0 (major version change).                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed the datatype of flowActivationTime and flowDeactivationTime in the Word doc to string.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  changed the following datatypes from number to integer: otherEndpointPort, reportingEndpointPort, samplingAlgorithm                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.8: otherFields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added otherFieldsVersion (set at 1.1)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added hashOfNameValuePairArrays                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added jsonObjects                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added nameValuePairs                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.9: added sipSignaling domain datatypes with 4.8.1 sipSignalingFields. sipSignalingFieldsVersion is set at 1.0                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.10 stateChangeFields: made stateChangeFieldsVersion a required field and set it to 2.0 (major version change).                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.11 syslogFields:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed the following datatypes from number to integer: syslogFacility, syslogPri                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed additionalFields from a field [ ] to a string which takes name=value pairs delimited by a pipe symbol.                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed syslogFieldsVersion to 3.0 (major version change) and made it a required field                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Made syslogSev an enumerated string (previously just a string)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.12 thresholdCrossingAlertFields: made thresholdCrossingFieldsVersion a required field and set it to 2.0 (major version change).                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.132: added voice quality domain datatypes with 4.13.1 endOfCallVqmSummaries and 4.13.2 voiceQualityFields. voiceQualityFieldsVersion is set at 1.0                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  JSON Schema: changed the schema to v28.0 and incorporated all of the changes above.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Additional JSON Schema changes that are part of v28: Note: The following changes are provided relative to API Spec v4.0 (which embedded JSON schema v27.0), but they were also made in an interim release v4.1 (which embedded JSON schema v27.2):                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  To support use of the schema with event batches, removed the following statement near the end of the schema file:                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |     “required”: [ “event” ]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fixed the characters used in some of the quotes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fixed some typos in the descriptions.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Removed the booleans, which were non-essential and which were causing problems across different implementations.                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 2 and 6 sample requests and responses (also incorporated in interim release 4.1):                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Removed quotes from numbers: sequence, and first/lastEpochMicrosec.                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Fixed all quote characters, some of which were using unusual symbols that wouldn’t validate with the json-schema Python package.                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 2 and 6 sample requests and responses (only in v5.0):                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed the version numbers in the URL string.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added nfNamingCode and nfcNamingCode and removed functionalRole                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6 call flows: updated the version number (only in v5.0).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6: removed the publishSpecificTopic operation                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.1.4: Buffering: clarified event source expectations for buffering (only in v5.0).                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.2.6.1, 6.3.6.1 sample requests (also incorporated in interim release 4.1):                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added an alarmAdditionalInformation field array to the sample requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added missing commas.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.2.6.3, 6.3.6.3 commandList sample responses (only in v5.0):                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Fixed the commandList sample responses to pass an array of anonymous command objects (rather than an array of commandListEntry objects).                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Fixed the heartbeatIntervalChange commandType to pass a heartbeatInterval value instead of a measurementInterval value.                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Removed quotes from the measurementInterval and heartbeatInterval values since they are numbers.                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.4.6.1 provideThrottlingState sample requests (also incorporated in interim release 4.1):                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Fixed the eventDomainThrottleSpecificationList to pass an array of anonymous eventDomainThrottleSpecification objects.                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added missing quotes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Fixed the suppressedNvPairsList to pass an array of anonymous suppressedNvPairs objects (also incorporated in interim release 4.1).                                                                                                                                                                                                                                                                                                                                                                                                              |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 5/22/2017    | v5.1       | -  Footers: removed proprietary markings and updated copyrights to 2017                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.2.3: field:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed the API spec to make ‘name’ and ‘value’ start with lowercase letters. Note: this did not affect the schema, which already had them as lowercase.                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  JSON Schema:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  measurementGroup: deleted this object since it was replaced with ‘namedArrayOfFields’ in v28.0 and was no longer being used.                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  namedArrayOfFields: Fixed an error in the specification of required fields: from ‘measurements’ to ‘arrayOfFields’.                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Changed the version of the JSON schema to 28.1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 6/14/2017    | v5.2       | -  JSON Schema: created v28.2 by changing the field descriptions in the memoryUsage object to refer to ‘kibibytes’ instead of ‘kilobytes’. There were no changes to the 28.1 structure.                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Word Document: measurementsForVfScaling Domain: memoryUsage object: changed the field descriptions in this object to refer to ‘kibibytes’ instead of ‘kilobytes’. There were no changes to the memoryUsage structure.                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Reorganized the Word document to group the data structures in Section 4 into three broad categories to better align with the VNF Guidelines documentation that has been prepared for vendors:                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Common Event Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  Command List Processing Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  Common Event Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  Common Event Header Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Technology Independent Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  ‘Fault Domain Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  ‘Heartbeat’ Domain Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  ‘Measurements For Vf Scaling’ Domain Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  ‘Other’ Domain Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  ‘State Change’ Domain Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  ‘Syslog’ Domain Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  ‘Threshold Crossing Alert’ Domain Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Technology Specify Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  ‘Mobile Flow’ Domain Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  ‘Sip Signaling’ Domain Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  ‘Voice Quality’ Domain Datatypes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.1.3: Commands Toward Event Source Clients: Added a statement: “Note: Vendors are not currently required to implement support for command processing; in addition, command processing may be supported by an App-C interface in future.”                                                                                                                                                                                                                                                                                                   |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 6/22/2017    | v5.3       | -  JSON Schema: created v28.3 by correcting an error in the sipSignalingFields: changed vnfVendorNameFields to vendorVnfNameFields. Embedded the new schema at the top of section 4.                                                                                                                                                                                                                                                                                                                                                                   |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 9/12/2017    | v5.4       | -  Note: There no changes to any data structures or operations in this version.                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  JSON Schema: created v28.4 embedded at the top of section 4:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added a reference to eventList in the properties defined under the schema title. This enables the schema to correctly validate event batches in addition to just events.                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Moved the schema title to the top of the schema and changed the text from “Event Listener” to “VES Event Listener”                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added a schema header block under the title to clearly communicate the schema version, associated API and last-modified information                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Changed the date in the copyright notice to 2017                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 9/19/2017    | v5.4.1     | -  Note: There no changes to any data structures or operations in this version.                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Back of Cover Page: updated the license and copyright notice to comply with ONAP guidelines                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  JSON Schema: updated the JSON schema to v28.4.1: updated the copyright notice and license to comply with ONAP guidelines                                                                                                                                                                                                                                                                                                                                                                                                                            |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 6/28/2018    | v6.0       | -  Added contributors to the title page.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Updated references to ‘vnf’ ‘vnfc’ to either ‘nf’ and ‘nfc’ or ‘xNf’ and ‘xNfc’ to generalize support across both vnfs and pnfs.                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 1:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  clarified the meaning of the VES acronym                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  changed references from ASDC to SDC and from MSO to SO                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  clarified the requirements for eventNames.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added a section of EventId use case examples                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added a new section on measurement expansion fields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added a new section of syslogs                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  clarified the versioning section and referenced the new API Versioning section in section 6.                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added a list of all the latest field block version numbers in this version of the API spec.                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 2: updated the sample to show use of new HTTP versioning headers. Added a note indicating that support for mutual SSL would be provided in future.                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 3: updated the resource structure remove the clientThrottlingState resource.                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: hashMaps. Changed all name-value pair structures to hashMaps causing the following data model and JSON schema (to v29.0) changes:                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.1.1: Common Event Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  removed "field" and added “hashMap”                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  removed “namedArrayOfFields” and added “namedHashMap”                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  added arrayOfNamedHashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  added arrayOfJsonObject                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.2.1: Fault Domain Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed the faultFields version to 3.0 (major change)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed faultFields.alarmAdditionalInformation to reference a hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.2.2: Heartbeat Domain Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed the heartbeatFieldsVersion to 2.0 (major change)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed heartbeatFields.additionalFields to reference a hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.2.3: Measurement Domain Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed the measurementFieldsVersion to 3.0 (major change)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed measurementFields.additionalFields to reference a hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed measurement.additionalMesurements to reference a namedHashMap [ ]                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  modified measurementFields.featureUsageArray to reference a hashmap and removed ‘featuresInUse’                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  added the following datatypes which are now referenced as items in arrays within measurementFields: hugePages, load, machineCheckException, processStats                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.2.5: Other Domain Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  Change the otherFieldsVersion to 2.0 (major change)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed otherFields.nameValuePairs to reference a hashMap and renamed it hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed otherFields.hashOfNameValuePairArrrays to reference a namedHashMap and renamed it arrayOfNamedHashMap                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.2.7: State Change Domain Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed the stateChangeFiledsVersion to 3.0 (major change)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed stateChangeFields.additionalFields to reference a hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.2.9: Threshold Crossing Alert Domain Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed the thresholdCrossingAlertFieldsVersion to 3.0 (major change)                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed thresholdCrossingAlertFields.additionalFields to reference a hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  counter: removed name and value elements and replaced with a hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.3.1: Mobile Flow Domain Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed the mobileFlowFieldsVersion to 3.0 (major change)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed mobileFlowFields.additionalFields to reference a hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  gtpPerFlowMetrics: modified ipTosCountList to reference hashmap                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  gtpPerFlowMetrics: modified mobileQciCosCountList to reference hashmap                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  gtpPerFlowMetrics: modified tcpFlagCountList to reference hashmap                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.3.2: Sip Signaling Domain Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed the sigSignalingFieldsVersion to 2.0 (major change)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed sipSignalingFields.additionalInformation to reference a hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.3.3: Voice Quality Domain Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  change the voiceQualityFieldsVersion to 2.0 (major change)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  changed voiceQualityFields.additionalInformation to reference a hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4: added notes at the top of section 4 clarifying expectations and requirements for optional fields, extensible fields and keys sent through extensible fields.                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Common Event Data Types: Section 4.1.1.9 Changed vendorVnfNameFields to vendorNfNameFields; updated Section 4.3.2 SipSignaling and 4.3.3 Voice Quality to refer to the renamed object                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Common Event Header Section 4.1.2:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  clarified the descriptions of eventId, reportingEntityName, sourceName and startEpochMicroseconds.                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added ‘notification’ and ‘pngRegistration’ to the domain enumeration.                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added a new timeZoneOffsest field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Fault Domain Section 4.2.1: clarified the definitions of alarmCondition, eventSeverity and specificProblem                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Measurements Domain Section 4.2.3: changed the name of this domain from ‘measurementsForVfScaling’ to ‘measurement’                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  measurementsForVfScaling measurement                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  measurementsForVfScalingFields measurementFields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  measurementsForVfScalingVersion measurementFieldsVersion                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  the ‘mfvs’ abbreviation measurement                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Measurements Domain Section 4.2.3 cpuUsage: added seven optional fields to this structure: cpuCapacityContention, cpuDemandAvg, cpuDemandMhz, cpuDemandPct, cpuLatencyAverage, cpuOverheadAvg, cpuSwapWaitTime                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Measurements Domain Section 4.2.3 diskUsage: added ten optional fields to this structure: diskBusResets, diskCommandsAborted, diskCommandsAvg, diskFlushRequests, diskFlushTime, diskReadCommandsAvg, diskTime, diskTotalReadLatencyAvg, diskTotalWriteLatencyAvg, diskWriteCommandsAvg                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Measurements Domain Section 4.2.3: added a new ‘ipmi’ datatype along with following ‘supporting’ datatypes: ipmiBaseboardTemperature, ipmiBaseboardVoltageRegulator, ipmiBattery, ipmiFan, ipmiGlobalAggregateTemperatureMargin, ipmiHsbp, ipmiNic, ipmiPowerSupply, ipmiProcessor, processorDimmAggregateThermalMargin                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Measurements Domain Section 4.2.3: added a new ‘load’ datatype                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Measurements Domain Section 4.2.3 memoryUsage: added eight optional fields to this structure: memoryDemand, memoryLatencyAvg, memorySharedAvg, memorySwapInAvg, memorySwapInRateAvg, memorySwapOutAvg, memorySwapOutRateAvg, memorySwapUsedAvg                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Measurements Domain Section 4.2.3: modified measurementFields to include the following new fields: hugePagesArray, ipmi, loadArray, memoryErrors, processStatusArray, rdtArray                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Measurements Domain Section 4.2.3 renamed vNicPerformance to nicPerformance and changed vNicIdentifer to nicIdentifier                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Notification Domain Section 4.2.4: added notificationFields to support a new notification domain.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  pnfRegistration Domain Section 4.2.7: added pnfRegistrationFields to support a new registration domain.                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  sysLog Domain Section 4.2.8: added two new fields: syslogMsgHost and syslogTs. Clarified field descriptions. Clarified syslogSData example.                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  endOfCallVqmSummaries Section 4.3.3.1:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  converted endpointJitter into two fields: endpointAverageJitter and endpointMaxJitter                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  converted localJitter into two fields: localAverageJitter and localMaxJitter                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added two fields: localAverageJitterBufferDelay and localMaxJitterBufferDelay                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added endpointRtpOctetsLost and endpointRtpPacketsLost                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added localRtpOctetsLost and localRtpPacketsLost                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  converted packetsLost into oneWayDelay                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  API Versioning:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Section 1.4: clarified the versioning section and linked it to the following new section 6.1.2                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Section 6.1.2: Added requirements for HTTP headers communicating minor, patch and latest version information.                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Section 2 and 6 sample messages: clarified examples to use the new HTTP headers                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.1.4: Added a section specifying message size limits.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section2 6.2.6.1 and 6.3.6.1: corrected additionalInformation examples to use hashMap instead of name-value pair fields.                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 7: Added a section on Terminology.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Command List Processing: removed command list processing from the document and schema:                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Modified the Section 3 resource structure to align with these changes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Removed Section 4 Datatypes: command, commandList, eventDomainThrottleSpecification, eventDomainThrottleSpecificationList, eventThrottlingState, suppressedNvPairs                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Removed Section 6.1 description of commands toward event source clients                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Removed Section 6.4 operation: provideThrottlingState                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 7/30/2018    | v7.0       | -  General:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Fixed typos throughout                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed example versions to v7                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section1:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Clarified casing and use of dashes versus colons in eventName examples                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Updated all field block versions                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 2: added a note clarifying that TLS 1.2 or higher must be used for HTTPS connections.                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4 embedded schema changed to v30:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added “ ‘additionalProperties’: false ” to objects to reject events that attempt to send properties that are not listed in the ‘properties’ keyword. Note: does not affect hashmap extensible fields.                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed all versions in all field blocks from number to string enum with the version number fixed by the enum so the schema can validate events that attempt to send non-standard field blocks.                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed syslog additionalFields to a hashMap                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Fixed section heading numbers that were the same.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.1.1: jsonObjectInstance: added an optional recursive jsonObject and removed all required fields from this object                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.1.2: commonEventHeader:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  nfVendorName: added this optional field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  timeZoneOffset: changed from number to string with a particular format specified                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  version was changed from number to string (as were all the version fields of all the field blocks)                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  vesCommonEventListenerVersion: added this required field as a string enumeration                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.2.3: Measurements Domain:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  Added a note clarifying that NFs are required to report exactly one Measurement event per period per sourceName                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  diskUsage: added four new optional fields: diskWeightedIoTimeAve, diskWeightedIoTimeLast, diskWeightedIoTimeMax, diskWeightedIoTimeMin                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  memoryUsage: add one new optional field: percentMemoryUsage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  nicPerformance: added nine new optional fields: administrativeState, operationalState, receivedPercentDiscard, receivedPercentError, receivedUtilization, speed, transmittedPercentDiscard, transmittedPercentError, transmittedUtilization                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |       -  processorDimmAggregateThermalMargin: make the thermalMargin field required                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  4.2.8: Syslog Domain:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Corrected the example at the end of the section                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 7/31/2018    | v7.0.1     | -  Section 4: The schema embedded at the top of section 4 was patched to correct a header field name error—the schema version moves from 30 to 30.0.1:                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed commonEventHeader field: ‘vesCommonEventFormatVersion’ field to ‘vesEventListenerVersion’ and set the enum to 7.0.1                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Also changed the commonEventHeader ‘required’ array to reflect use the corrected field name: ‘vesEventListenerVersion’                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed the commonEventHeader ‘version’ field enumeration to 4.0.1                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section1:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed the field block versions for the common header for ‘vesEventListenerVersion’ (to 7.0.1) and ‘version’ (to 4.0.1).                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Sections 2 and 6:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed the commonEventHeader version fields above, in the sample message requests and responses; also updated the faultFieldsVersion to 4.0                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6.1.2: Changed the X-LatestVersion to 7.0.1 and the X-PatchVersion to 1                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 12/10/2018   | v7.1       | -  Section 1.2: Added Notification domain Perf3gpp domain and changed a reference from ‘measurements domain’ to ‘measurement domain’.                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 1.7.1: Field Block Versions: added ‘perf3gppFields’ version at 1.0 and changed the following version enumerations so that existing clients of major version 7 would not be broken by this VES minor version change, in accordance with semantic versioning definitions:                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  commonEventHeader: changed to ‘vesEventListenerVersion’ enum to accept either 7.0 or 7.0.1 or 7.1.                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  commonEventHeader: changed ‘version’ enum to accept either 4.0 or 4.0.1 or 4.1                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 2:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  changed sample request and responses to reference 7.1 instead of 7.0.1 (and version 4.1 of the commonEventHeader version, instead of v4.0.1)                                                                                                                                                                                                                                                                                                                                                                                                     |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  added a sub section on service provider support for mutual ssl certificate authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.1.2.1:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  CommonEventHeader timeZoneOffset changed description from ‘UTC+/-hh.mm’ to ‘UTC+/-hh:mm’                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Added ‘perf3gpp’ to the domain enumeration                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.2.3: Measurement Domain Datatypes:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  In ‘MeasurementFields’: Changed ‘ipmiArray’ to ‘ipmi’ and made the type ‘object’                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  ‘ipmiProcessor’: changed ‘pprocessorThermalControl’ to ‘processorThermalControl’                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  ‘machineCheckException’: changed ‘processIdentifier’ to ‘vmIdentifier’                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4.2.6: added the perf3gpp domain                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 4 embedded schema:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  Changed the schema version from 30.0.1 to 30.1 as a result of the changes below:                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  commonEventHeader: changed to ‘vesEventListenerVersion’ enum to accept either 7.0, 7.0.1 or 7.1                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  commonEventHeader: changed the ‘version’ field enumeration to accept either 4.0, 4.0.1 or 4.1                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  commonEventHeader: changed the ‘domain’ enumeration to add support for the perf3gpp domain.                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  ‘event’: added a reference to ‘perf3gppFields’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  ‘hugePages’: changed the type of hugePagesIdentifier from number to string                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  ‘ipmiGlobalAggregateTemperatureMargin’: changed ‘pmiGlobalAggregateTemperatureMarginIdentifier’ to ‘globalAggregateTemperatureMarginIdentifier’                                                                                                                                                                                                                                                                                                                                                                                                  |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            |    -  ‘perf3gppFields’: added this object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|              |            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|              |            | -  Section 6: changed references throughout from v7.0.1 to v7.1 and v4.0.1 (of the commonEventHeader version) to v4.1                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. |image0| image:: media/image3.png
   :width: 6.48926in
   :height: 4.86694in
.. |image1| image:: media/image4.png
   :width: 6.50000in
   :height: 4.87450in
.. |image2| image:: media/image5.png
   :width: 3.76033in
   :height: 1.16677in
.. |image3| image:: media/image7.png
   :width: 4.75347in
   :height: 2.57361in
.. |image4| image:: media/image8.png
   :width: 4.74722in
   :height: 2.56667in