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
|
<pre>Internet Engineering Task Force (IETF) J. Schoenwaelder
Request for Comments: 8194 Jacobs University Bremen
Category: Standards Track V. Bajpai
ISSN: 2070-1721 Technical University of Munich
August 2017
<span class="h1">A YANG Data Model for LMAP Measurement Agents</span>
Abstract
This document defines a data model for Large-Scale Measurement
Platforms (LMAPs). The data model is defined using the YANG data
modeling language.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc7841#section-2">Section 2 of RFC 7841</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc8194">http://www.rfc-editor.org/info/rfc8194</a>.
Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
Table of Contents
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
<a href="#section-1.1">1.1</a>. Terminology . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
<a href="#section-1.2">1.2</a>. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
<a href="#section-2">2</a>. Data Model Overview . . . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-3">3</a>. Relationship to the Information Model . . . . . . . . . . . . <a href="#page-9">9</a>
<a href="#section-4">4</a>. YANG Modules . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
<a href="#section-4.1">4.1</a>. LMAP Common YANG Module . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
<a href="#section-4.2">4.2</a>. LMAP Control YANG Module . . . . . . . . . . . . . . . . <a href="#page-18">18</a>
<a href="#section-4.3">4.3</a>. LMAP Report YANG Module . . . . . . . . . . . . . . . . . <a href="#page-40">40</a>
<a href="#section-5">5</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-45">45</a>
<a href="#section-6">6</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-47">47</a>
<a href="#section-7">7</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-48">48</a>
<a href="#section-7.1">7.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-48">48</a>
<a href="#section-7.2">7.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-49">49</a>
<a href="#appendix-A">Appendix A</a>. Example Parameter Extension Module . . . . . . . . . <a href="#page-51">51</a>
<a href="#appendix-B">Appendix B</a>. Example Configuration . . . . . . . . . . . . . . . <a href="#page-53">53</a>
<a href="#appendix-C">Appendix C</a>. Example Report . . . . . . . . . . . . . . . . . . . <a href="#page-56">56</a>
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-59">59</a>
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-59">59</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
This document defines a data model for Large-Scale Measurement
Platforms (LMAPs) [<a href="./rfc7594" title=""A Framework for Large-Scale Measurement of Broadband Performance (LMAP)"">RFC7594</a>]. The data model is defined using the
YANG [<a href="./rfc7950" title=""The YANG 1.1 Data Modeling Language"">RFC7950</a>] data modeling language. It is based on the LMAP
Information Model [<a href="./rfc8193" title=""Information Model for Large-Scale Measurement Platforms (LMAPs)"">RFC8193</a>].
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Terminology</span>
This document uses the LMAP terminology defined in [<a href="./rfc7594" title=""A Framework for Large-Scale Measurement of Broadband Performance (LMAP)"">RFC7594</a>].
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in <a href="https://www.rfc-editor.org/bcp/bcp14">BCP</a>
<a href="https://www.rfc-editor.org/bcp/bcp14">14</a> [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>] [<a href="./rfc8174" title=""Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"">RFC8174</a>] when, and only when, they appear in all
capitals, as shown here.
<span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Tree Diagrams</span>
A simplified graphical representation of the data model is used in
this document. The meaning of the symbols in these diagrams is as
follows:
o Brackets "[" and "]" enclose list keys.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
o Abbreviations before data node names: "rw" means configuration
(read-write), "ro" means state data (read-only), and "w" means RPC
input data (write-only).
o Symbols after data node names: "?" means an optional node, "!"
means a presence container, and "*" denotes a list and leaf-list.
o Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":").
o Ellipsis ("...") stands for contents of subtrees that are not
shown.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Data Model Overview</span>
The LMAP framework has three basic elements: Measurement Agents
(MAs), Controllers, and Collectors. Measurement Agents initiate the
actual measurements, which are called Measurement Tasks in the LMAP
terminology. The Controller instructs one or more MAs and
communicates the set of Measurement Tasks an MA should perform and
when. The Collector accepts Reports from the MAs with the Results
from their Measurement Tasks.
The YANG data model for LMAP has been split into three modules:
1. The module ietf-lmap-common.yang provides common definitions such
as LMAP-specific data types.
2. The module ietf-lmap-control.yang defines the data structures
exchanged between a Controller and Measurement Agents.
3. The module ietf-lmap-report.yang defines the data structures
exchanged between Measurement Agents and Collectors.
As shown in Figure 1, a Controller, implementing
ietf-lmap-common.yang and ietf-lmap-control.yang as a client, will
instruct Measurement Agents, which implement ietf-lmap-common.yang
and ietf-lmap-control.yang as servers. A Measurement Agent,
implementing ietf-lmap-common.yang and ietf-lmap-report.yang, will
send results to a Collector, which implements ietf-lmap-common.yang
and ietf-lmap-report.yang as a server.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
+------------------------+
| LMAP Controller |
| |
| Client: |
| ietf-lmap-common.yang |
| ietf-lmap-control.yang |
+------------------------+
+------------------------+ |
| LMAP Measurement Agent | |
| | <- request |
| Server: |<---------------------'
| ietf-lmap-common.yang | response ->
| ietf-lmap-control.yang |
| |
| | request ->
| Client: |----------------------.
| ietf-lmap-common.yang | <- response |
| ietf-lmap-report.yang | |
+------------------------+ v
+------------------------+
| LMAP Collector |
| |
| Server: |
| ietf-lmap-common.yang |
| ietf-lmap-report.yang |
+------------------------+
Figure 1: The LMAP Controller, Measurement Agent, and Collector and
the YANG Modules They Implement as Client or Server
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
The tree diagram below shows the structure of the control data model.
module: ietf-lmap-control
+--rw lmap
+--ro capabilities
| +--ro version string
| +--ro tag* lmap:tag
| +--ro tasks
| +--ro task* [name]
| +--ro name lmap:identifier
| +--ro function* [uri]
| | +--ro uri inet:uri
| | +--ro role* string
| +--ro version? string
| +--ro program? string
+--rw agent
| +--rw agent-id? yang:uuid
| +--rw group-id? string
| +--rw measurement-point? string
| +--rw report-agent-id? boolean
| +--rw report-group-id? boolean
| +--rw report-measurement-point? boolean
| +--rw controller-timeout? uint32
| +--ro last-started yang:date-and-time
+--rw tasks
| +--rw task* [name]
| +--rw name lmap:identifier
| +--rw function* [uri]
| | +--rw uri inet:uri
| | +--rw role* string
| +--rw program? string
| +--rw option* [id]
| | +--rw id lmap:identifier
| | +--rw name? string
| | +--rw value? string
| +--rw tag* lmap:identifier
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
+--rw schedules
| +--rw schedule* [name]
| +--rw name lmap:identifier
| +--rw start event-ref
| +--rw (stop)?
| | +--:(end)
| | | +--rw end? event-ref
| | +--:(duration)
| | +--rw duration? uint32
| +--rw execution-mode? enumeration
| +--rw tag* lmap:tag
| +--rw suppression-tag* lmap:tag
| +--ro state enumeration
| +--ro storage yang:gauge64
| +--ro invocations yang:counter32
| +--ro suppressions yang:counter32
| +--ro overlaps yang:counter32
| +--ro failures yang:counter32
| +--ro last-invocation? yang:date-and-time
| +--rw action* [name]
| +--rw name lmap:identifier
| +--rw task task-ref
| +--rw parameters
| | +--rw (extension)?
| +--rw option* [id]
| | +--rw id lmap:identifier
| | +--rw name? string
| | +--rw value? string
| +--rw destination* schedule-ref
| +--rw tag* lmap:tag
| +--rw suppression-tag* lmap:tag
| +--ro state enumeration
| +--ro storage yang:gauge64
| +--ro invocations yang:counter32
| +--ro suppressions yang:counter32
| +--ro overlaps yang:counter32
| +--ro failures yang:counter32
| +--ro last-invocation yang:date-and-time
| +--ro last-completion yang:date-and-time
| +--ro last-status lmap:status-code
| +--ro last-message string
| +--ro last-failed-completion yang:date-and-time
| +--ro last-failed-status lmap:status-code
| +--ro last-failed-message string
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
+--rw suppressions
| +--rw suppression* [name]
| +--rw name lmap:identifier
| +--rw start? event-ref
| +--rw end? event-ref
| +--rw match* lmap:glob-pattern
| +--rw stop-running? boolean
| +--ro state enumeration
+--rw events
+--rw event* [name]
+--rw name lmap:identifier
+--rw random-spread? uint32
+--rw cycle-interval? uint32
+--rw (event-type)?
+--:(periodic)
| +--rw periodic
| +--rw interval uint32
| +--rw start? yang:date-and-time
| +--rw end? yang:date-and-time
+--:(calendar)
| +--rw calendar
| +--rw month* lmap:month-or-all
| +--rw day-of-month* lmap:day-of-months-or-all
| +--rw day-of-week* lmap:weekday-or-all
| +--rw hour* lmap:hour-or-all
| +--rw minute* lmap:minute-or-all
| +--rw second* lmap:second-or-all
| +--rw timezone-offset? lmap:timezone-offset
| +--rw start? yang:date-and-time
| +--rw end? yang:date-and-time
+--:(one-off)
| +--rw one-off
| +--rw time yang:date-and-time
+--:(immediate)
| +--rw immediate empty
+--:(startup)
| +--rw startup empty
+--:(controller-lost)
| +--rw controller-lost empty
+--:(controller-connected)
+--rw controller-connected empty
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
The tree diagram below shows the structure of the reporting data
model.
module: ietf-lmap-report
rpcs:
+---x report
+---w input
+---w date yang:date-and-time
+---w agent-id? yang:uuid
+---w group-id? string
+---w measurement-point? string
+---w result*
+---w schedule? lmap:identifier
+---w action? lmap:identifier
+---w task? lmap:identifier
+---w parameters
| +---w (extension)?
+---w option* [id]
| +---w id lmap:identifier
| +---w name? string
| +---w value? string
+---w tag* lmap:tag
+---w event? yang:date-and-time
+---w start yang:date-and-time
+---w end? yang:date-and-time
+---w cycle-number? lmap:cycle-number
+---w status lmap:status-code
+---w conflict*
| +---w schedule-name? lmap:identifier
| +---w action-name? lmap:identifier
| +---w task-name? lmap:identifier
+---w table*
+---w function* [uri]
| +---w uri inet:uri
| +---w role* string
+---w column* string
+---w row*
+---w value* string
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Relationship to the Information Model</span>
The LMAP Information Model [<a href="./rfc8193" title=""Information Model for Large-Scale Measurement Platforms (LMAPs)"">RFC8193</a>] is divided into six aspects.
They are mapped into the YANG data model as explained below:
o Preconfiguration Information: This is not modeled explicitly since
bootstrapping information is outside the scope of this data model.
Implementations may use some of the Configuration Information also
for bootstrapping purposes.
o Configuration Information: This is modeled in the /lmap/agent
subtree, the /lmap/schedules subtree, and the /lmap/tasks subtree
described below. Some items have been left out because they are
expected to be dealt with by the underlying protocol.
o Instruction Information: This is modeled in the /lmap/suppressions
subtree, the /lmap/schedules subtree, and the /lmap/tasks subtree
described below.
o Logging Information: Some of the Logging Information, in
particular 'success/failure/warning messages in response to
information updates from the Controller', will be handled by the
protocol used to manipulate the LMAP-specific configuration. The
LMAP data model defined in this document assumes that runtime
Logging Information will be communicated using protocols that do
not require a formal data model, e.g., the syslog protocol defined
in [<a href="./rfc5424" title=""The Syslog Protocol"">RFC5424</a>].
o Capability and Status Information: Some of the Capability and
Status Information is modeled in the /lmap/capability subtree.
The list of supported Tasks is modeled in the /lmap/capabilities/
task list. Status Information about Schedules and Actions is
included in the /lmap/schedules subtree. Information about
network interfaces can be obtained from the ietf-interfaces YANG
data model [<a href="./rfc7223" title=""A YANG Data Model for Interface Management"">RFC7223</a>]. Information about the hardware and the
firmware can be obtained from the ietf-system YANG data model
[<a href="./rfc7317" title=""A YANG Data Model for System Management"">RFC7317</a>]. A device identifier can be obtained from the ietf-
hardware YANG data model [<a href="#ref-YANG-HARDWARE">YANG-HARDWARE</a>].
o Reporting Information: This is modeled by the report data model to
be implemented by the Collector. Measurement Agents send results
to the Collector by invoking an RPC on the Collector.
These six Information Model aspects use a collection of common
information objects. These common information objects are
represented in the YANG data model as follows:
o Schedules: Schedules are modeled in the /lmap/schedules subtree.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
o Channels: Channels are not modeled since the NETCONF server
configuration data model [<a href="#ref-NETCONF-CLIENT-SERVER">NETCONF-CLIENT-SERVER</a>] already provides
a mechanism to configure NETCONF server Channels.
o Task Configurations: Configured Tasks are modeled in the /lmap/
tasks subtree.
o Event Information: Event definitions are modeled in the /lmap/
events subtree.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. YANG Modules</span>
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. LMAP Common YANG Module</span>
This module imports definitions from [<a href="./rfc6536" title=""Network Configuration Protocol (NETCONF) Access Control Model"">RFC6536</a>], and it references
[<a href="#ref-ISO-8601">ISO-8601</a>].
<CODE BEGINS> file "ietf-lmap-common@2017-08-08.yang"
module ietf-lmap-common {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-common";
prefix "lmap";
import ietf-inet-types {
prefix inet;
}
organization
"IETF Large-Scale Measurement of Broadband Performance
Working Group";
contact
"WG Web: <<a href="https://datatracker.ietf.org/wg/lmap">https://datatracker.ietf.org/wg/lmap</a>>
WG List: <mailto:lmap@ietf.org>
Editor: Juergen Schoenwaelder
<j.schoenwaelder@jacobs-university.de>
Editor: Vaibhav Bajpai
<bajpaiv@in.tum.de>";
description
"This module provides common definitions used by the data
models written for Large-Scale Measurement Platforms (LMAPs).
This module defines typedefs and groupings but no schema
tree elements.";
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
revision "2017-08-08" {
description
"Initial version";
reference
"<a href="./rfc8194">RFC 8194</a>: A YANG Data Model for LMAP Measurement Agents";
}
/*
* Typedefs
*/
typedef identifier {
type string {
length "1..max";
}
description
"A string value used to name something.";
}
typedef tag {
type string {
length "1..max";
}
description
"A tag consists of at least one character.";
}
typedef glob-pattern {
type string {
length "1..max";
}
description
'A glob style pattern (following POSIX.2 fnmatch() without
special treatment of file paths):
* matches a sequence of characters
? matches a single character
[seq] matches any character in seq
[!seq] matches any character not in seq
A backslash followed by a character matches the following
character. In particular:
\* matches *
\? matches ?
\\ matches \
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
A sequence seq may be a sequence of characters (e.g., [abc]
or a range of characters (e.g., [a-c]).';
}
typedef wildcard {
type string {
pattern '\*';
}
description
"A wildcard for calendar scheduling entries.";
}
typedef cycle-number {
type string {
pattern '[0-9]{8}\.[0-9]{6}';
}
description
"A cycle number represented in the format YYYYMMDD.HHMMSS
where YYYY represents the year, MM the month (1..12), DD
the day of the months (01..31), HH the hour (00..23), MM
the minute (00..59), and SS the second (00..59). The cycle
number is using Coordinated Universal Time (UTC).";
}
typedef month {
type enumeration {
enum january {
value 1;
description
"January of the Gregorian calendar.";
}
enum february {
value 2;
description
"February of the Gregorian calendar.";
}
enum march {
value 3;
description
"March of the Gregorian calendar.";
}
enum april {
value 4;
description
"April of the Gregorian calendar.";
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
enum may {
value 5;
description
"May of the Gregorian calendar.";
}
enum june {
value 6;
description
"June of the Gregorian calendar.";
}
enum july {
value 7;
description
"July of the Gregorian calendar.";
}
enum august {
value 8;
description
"August of the Gregorian calendar.";
}
enum september {
value 9;
description
"September of the Gregorian calendar.";
}
enum october {
value 10;
description
"October of the Gregorian calendar.";
}
enum november {
value 11;
description
"November of the Gregorian calendar.";
}
enum december {
value 12;
description
"December of the Gregorian calendar.";
}
}
description
"A type modeling the month in the Gregorian calendar.";
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
typedef month-or-all {
type union {
type month;
type wildcard;
}
description
"A month or a wildcard indicating all twelve months.";
}
typedef day-of-month {
type uint8 { range "1..31"; }
description
"A day of a month of the Gregorian calendar.";
}
typedef day-of-months-or-all {
type union {
type day-of-month;
type wildcard;
}
description
"A day of a month or a wildcard indicating all days
of a month.";
}
typedef weekday {
type enumeration {
enum monday {
value 1;
description
"Monday of the Gregorian calendar.";
}
enum tuesday {
value 2;
description
"Tuesday of the Gregorian calendar.";
}
enum wednesday {
value 3;
description
"Wednesday of the Gregorian calendar.";
}
enum thursday {
value 4;
description
"Thursday of the Gregorian calendar.";
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
enum friday {
value 5;
description
"Friday of the Gregorian calendar.";
}
enum saturday {
value 6;
description
"Saturday of the Gregorian calendar.";
}
enum sunday {
value 7;
description
"Sunday of the Gregorian calendar.";
}
}
description
"A type modeling the weekdays in the Gregorian calendar.
The numbering follows the ISO 8601 scheme.";
reference
"ISO 8601:2004: Data elements and interchange formats --
Information interchange -- Representation
of dates and times";
}
typedef weekday-or-all {
type union {
type weekday;
type wildcard;
}
description
"A weekday or a wildcard indicating all seven weekdays.";
}
typedef hour {
type uint8 { range "0..23"; }
description
"An hour of a day.";
}
typedef hour-or-all {
type union {
type hour;
type wildcard;
}
description
"An hour of a day or a wildcard indicating all hours
of a day.";
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
}
typedef minute {
type uint8 { range "0..59"; }
description
"A minute of an hour.";
}
typedef minute-or-all {
type union {
type minute;
type wildcard;
}
description
"A minute of an hour or a wildcard indicating all
minutes of an hour.";
}
typedef second {
type uint8 { range "0..59"; }
description
"A second of a minute.";
}
typedef second-or-all {
type union {
type second;
type wildcard;
}
description
"A second of a minute or a wildcard indicating all
seconds of a minute.";
}
typedef status-code {
type int32;
description
"A status code returned by the execution of a Task. Note
that the actual range is implementation dependent, but it
should be portable to use values in the range 0..127 for
regular exit codes. By convention, 0 indicates successful
termination. Negative values may be used to indicate
abnormal termination due to a signal; the absolute value
may identify the signal number in this case.";
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
typedef timezone-offset {
type string {
pattern 'Z|[\+\-]\d{2}:\d{2}';
}
description
"A time zone offset as it is used by the date-and-time type
defined in the ietf-yang-types module. The value Z is
equivalent to +00:00. The value -00:00 indicates an
unknown time-offset.";
reference
"<a href="./rfc6991">RFC 6991</a>: Common YANG Data Types";
}
/*
* Groupings
*/
grouping registry-grouping {
description
"This grouping models a list of entries in a registry
that identify functions of a Task.";
list function {
key uri;
description
"A list of entries in a registry identifying functions.";
leaf uri {
type inet:uri;
description
"A URI identifying an entry in a registry.";
}
leaf-list role {
type string;
description
"A set of roles for the identified registry entry.";
}
}
}
grouping options-grouping {
description
"A list of options of a Task. Each option is a name/value
pair (where the value may be absent).";
list option {
key "id";
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
ordered-by user;
description
"A list of options passed to the Task. It is a list of
key/value pairs and may be used to model options.
Options may be used to identify the role of a Task
or to pass a Channel name to a Task.";
leaf id {
type lmap:identifier;
description
"An identifier uniquely identifying an option. This
identifier is required by YANG to uniquely identify
a name/value pair, but it otherwise has no semantic
value";
}
leaf name {
type string;
description
"The name of the option.";
}
leaf value {
type string;
description
"The value of the option.";
}
}
}
}
<CODE ENDS>
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. LMAP Control YANG Module</span>
This module imports definitions from [<a href="./rfc6536" title=""Network Configuration Protocol (NETCONF) Access Control Model"">RFC6536</a>], [<a href="./rfc6991" title=""Common YANG Data Types"">RFC6991</a>], and the
common LMAP module, and it references [<a href="./rfc7398" title=""A Reference Path and Measurement Points for Large-Scale Measurement of Broadband Performance"">RFC7398</a>].
<CODE BEGINS> file "ietf-lmap-control@2017-08-08.yang"
module ietf-lmap-control {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-control";
prefix "lmapc";
import ietf-yang-types {
prefix yang;
}
import ietf-netconf-acm {
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
prefix nacm;
}
import ietf-lmap-common {
prefix lmap;
}
organization
"IETF Large-Scale Measurement of Broadband Performance
Working Group";
contact
"WG Web: <<a href="https://datatracker.ietf.org/wg/lmap">https://datatracker.ietf.org/wg/lmap</a>>
WG List: <mailto:lmap@ietf.org>
Editor: Juergen Schoenwaelder
<j.schoenwaelder@jacobs-university.de>
Editor: Vaibhav Bajpai
<bajpaiv@in.tum.de>";
description
"This module defines a data model for controlling Measurement
Agents that are part of a Large-Scale Measurement Platform
(LMAP). This data model is expected to be implemented by
Measurement Agents.";
revision "2017-08-08" {
description
"Initial version";
reference
"<a href="./rfc8194">RFC 8194</a>: A YANG Data Model for LMAP Measurement Agents";
}
/*
* Typedefs
*/
typedef event-ref {
type leafref {
path "/lmap/events/event/name";
}
description
"This type is used by data models that need to reference
a configured event source.";
}
typedef task-ref {
type leafref {
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
path "/lmap/tasks/task/name";
}
description
"This type is used by data models that need to reference
a configured Task.";
}
typedef schedule-ref {
type leafref {
path "/lmap/schedules/schedule/name";
}
description
"This type is used by data models that need to reference
a configured Schedule.";
}
/*
* Groupings
*/
grouping start-end-grouping {
description
"A grouping that provides start and end times for
Event objects.";
leaf start {
type yang:date-and-time;
description
"The date and time when the Event object
starts to create triggers.";
}
leaf end {
type yang:date-and-time;
description
"The date and time when the Event object
stops to create triggers.
It is generally a good idea to always configure
an end time and to refresh the end time as needed
to ensure that agents that lose connectivity to
their Controller do not continue executing Schedules
forever.";
}
}
/*
* Capability, configuration, and state data nodes
*/
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
container lmap {
description
"Configuration and control of a Measurement Agent.";
container capabilities {
config false;
description
"Agent capabilities including a list of supported Tasks.";
leaf version {
type string;
config false;
mandatory true;
description
"A short description of the software implementing the
Measurement Agent. This should include the version
number of the Measurement Agent software.";
}
leaf-list tag {
type lmap:tag;
config false;
description
"An optional unordered set of tags that provide
additional information about the capabilities of
the Measurement Agent.";
}
container tasks {
description
"A list of Tasks that the Measurement Agent supports.";
list task {
key name;
description
"The list of Tasks supported by the Measurement Agent.";
leaf name {
type lmap:identifier;
description
"The unique name of a Task capability.";
}
uses lmap:registry-grouping;
leaf version {
type string;
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"A short description of the software implementing
the Task. This should include the version
number of the Measurement Task software.";
}
leaf program {
type string;
description
"The (local) program to invoke in order to execute
the Task.";
}
}
}
}
/*
* Agent Configuration
*/
container agent {
description
"Configuration of parameters affecting the whole
Measurement Agent.";
leaf agent-id {
type yang:uuid;
description
"The agent-id identifies a Measurement Agent with
a very low probability of collision. In certain
deployments, the agent-id may be considered
sensitive, and hence this object is optional.";
}
leaf group-id {
type string;
description
"The group-id identifies a group of Measurement
Agents. In certain deployments, the group-id
may be considered less sensitive than the
agent-id.";
}
leaf measurement-point {
type string;
description
"The measurement point indicating where the
Measurement Agent is located on a path.";
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
reference
"<a href="./rfc7398">RFC 7398</a>: A Reference Path and Measurement Points
for Large-Scale Measurement of Broadband
Performance";
}
leaf report-agent-id {
type boolean;
must '. != "true" or ../agent-id' {
description
"An agent-id must exist for this to be set
to true.";
}
default false;
description
"The 'report-agent-id' controls whether the
'agent-id' is reported to Collectors.";
}
leaf report-group-id {
type boolean;
must '. != "true" or ../group-id' {
description
"A group-id must exist for this to be set
to true.";
}
default false;
description
"The 'report-group-id' controls whether the
'group-id' is reported to Collectors.";
}
leaf report-measurement-point {
type boolean;
must '. != "true" or ../measurement-point' {
description
"A measurement-point must exist for this to be
set to true.";
}
default false;
description
"The 'report-measurement-point' controls whether
the 'measurement-point' is reported to Collectors.";
}
leaf controller-timeout {
type uint32;
units "seconds";
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"A timer is started after each successful contact
with a Controller. When the timer reaches the
controller-timeout, an event (controller-lost) is
raised indicating that connectivity to the Controller
has been lost.";
}
leaf last-started {
type yang:date-and-time;
config false;
mandatory true;
description
"The date and time the Measurement Agent last started.";
}
}
/*
* Task Configuration
*/
container tasks {
description
"Configuration of LMAP Tasks.";
list task {
key name;
description
"The list of Tasks configured on the Measurement
Agent. Note that a configured Task MUST resolve to a
Task listed in the capabilities. Attempts to execute
a configured Task that is not listed in the capabilities
result in a runtime execution error.";
leaf name {
type lmap:identifier;
description
"The unique name of a Task.";
}
uses lmap:registry-grouping;
leaf program {
type string;
nacm:default-deny-write;
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"The (local) program to invoke in order to execute
the Task. If this leaf is not set, then the system
will try to identify a suitable program based on
the registry information present.";
}
uses lmap:options-grouping {
description
"The list of Task-specific options.";
}
leaf-list tag {
type lmap:identifier;
description
"A set of Task-specific tags that are reported
together with the measurement results to a Collector.
A tag can be used, for example, to carry the
Measurement Cycle ID.";
}
}
}
/*
* Schedule Instructions
*/
container schedules {
description
"Configuration of LMAP Schedules. Schedules control
which Tasks are executed by the LMAP implementation.";
list schedule {
key name;
description
"Configuration of a particular Schedule.";
leaf name {
type lmap:identifier;
description
"The locally unique, administratively assigned name
for this Schedule.";
}
leaf start {
type event-ref;
mandatory true;
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"The event source controlling the start of the
scheduled Actions.";
}
choice stop {
description
"This choice contains optional leafs that control the
graceful forced termination of scheduled Actions.
When the end has been reached, the scheduled Actions
should be forced to terminate the measurements.
This may involve being active some additional time in
order to properly finish the Action's activity (e.g.,
waiting for any messages that are still outstanding).";
leaf end {
type event-ref;
description
"The event source controlling the graceful
forced termination of the scheduled Actions.";
}
leaf duration {
type uint32;
units "seconds";
description
"The duration controlling the graceful forced
termination of the scheduled Actions.";
}
}
leaf execution-mode {
type enumeration {
enum sequential {
value 1;
description
"The Actions of the Schedule are executed
sequentially.";
}
enum parallel {
value 2;
description
"The Actions of the Schedule are executed
concurrently.";
}
enum pipelined {
value 3;
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"The Actions of the Schedule are executed in a
pipelined mode. Output created by an Action is
passed as input to the subsequent Action.";
}
}
default pipelined;
description
"The execution mode of this Schedule determines in
which order the Actions of the Schedule are executed.";
}
leaf-list tag {
type lmap:tag;
description
"A set of Schedule-specific tags that are reported
together with the measurement results to a Collector.";
}
leaf-list suppression-tag {
type lmap:tag;
description
"A set of Suppression tags that are used to select
Schedules to be suppressed.";
}
leaf state {
type enumeration {
enum enabled {
value 1;
description
"The value 'enabled' indicates that the
Schedule is currently enabled.";
}
enum disabled {
value 2;
description
"The value 'disabled' indicates that the
Schedule is currently disabled.";
}
enum running {
value 3;
description
"The value 'running' indicates that the
Schedule is currently running.";
}
enum suppressed {
value 4;
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"The value 'suppressed' indicates that the
Schedule is currently suppressed.";
}
}
config false;
mandatory true;
description
"The current state of the Schedule.";
}
leaf storage {
type yang:gauge64;
units "bytes";
config false;
mandatory true;
description
"The amount of secondary storage (e.g., allocated in a
file system) holding temporary data allocated to the
Schedule in bytes. This object reports the amount of
allocated physical storage and not the storage used
by logical data records.";
}
leaf invocations {
type yang:counter32;
config false;
mandatory true;
description
"Number of invocations of this Schedule. This counter
does not include suppressed invocations or invocations
that were prevented due to an overlap with a previous
invocation of this Schedule.";
}
leaf suppressions {
type yang:counter32;
config false;
mandatory true;
description
"Number of suppressed executions of this Schedule.";
}
leaf overlaps {
type yang:counter32;
config false;
mandatory true;
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"Number of executions prevented due to overlaps with
a previous invocation of this Schedule.";
}
leaf failures {
type yang:counter32;
config false;
mandatory true;
description
"Number of failed executions of this Schedule. A
failed execution is an execution where at least
one Action failed.";
}
leaf last-invocation {
type yang:date-and-time;
config false;
description
"The date and time of the last invocation of
this Schedule.";
}
list action {
key name;
description
"An Action describes a Task that is invoked by the
Schedule. Multiple Actions are invoked according to
the execution-mode of the Schedule.";
leaf name {
type lmap:identifier;
description
"The unique identifier for this Action.";
}
leaf task {
type task-ref;
mandatory true;
description
"The Task invoked by this Action.";
}
container parameters {
description
"This container is a placeholder for runtime
parameters defined in Task-specific data models
augmenting the base LMAP control data model.";
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
choice extension {
description
"This choice is provided to augment in different
sets of parameters.";
}
}
uses lmap:options-grouping {
description
"The list of Action-specific options that are
appended to the list of Task-specific options.";
}
leaf-list destination {
type schedule-ref;
description
"A set of Schedules receiving the output produced
by this Action. The output is stored temporarily
since the Destination Schedules will in general
not be running when output is passed to them. The
behavior of an Action passing data to its own
Schedule is implementation specific.
Data passed to a sequential or pipelined Schedule
is received by the Schedule's first Action. Data
passed to a parallel Schedule is received by all
Actions of the Schedule.";
}
leaf-list tag {
type lmap:tag;
description
"A set of Action-specific tags that are reported
together with the measurement results to a
Collector.";
}
leaf-list suppression-tag {
type lmap:tag;
description
"A set of Suppression tags that are used to select
Actions to be suppressed.";
}
leaf state {
type enumeration {
enum enabled {
value 1;
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"The value 'enabled' indicates that the
Action is currently enabled.";
}
enum disabled {
value 2;
description
"The value 'disabled' indicates that the
Action is currently disabled.";
}
enum running {
value 3;
description
"The value 'running' indicates that the
Action is currently running.";
}
enum suppressed {
value 4;
description
"The value 'suppressed' indicates that the
Action is currently suppressed.";
}
}
config false;
mandatory true;
description
"The current state of the Action.";
}
leaf storage {
type yang:gauge64;
units "bytes";
config false;
mandatory true;
description
"The amount of secondary storage (e.g., allocated in a
file system) holding temporary data allocated to the
Schedule in bytes. This object reports the amount of
allocated physical storage and not the storage used
by logical data records.";
}
leaf invocations {
type yang:counter32;
config false;
mandatory true;
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"Number of invocations of this Action. This counter
does not include suppressed invocations or invocations
that were prevented due to an overlap with a previous
invocation of this Action.";
}
leaf suppressions {
type yang:counter32;
config false;
mandatory true;
description
"Number of suppressed executions of this Action.";
}
leaf overlaps {
type yang:counter32;
config false;
mandatory true;
description
"Number of executions prevented due to overlaps with
a previous invocation of this Action.";
}
leaf failures {
type yang:counter32;
config false;
mandatory true;
description
"Number of failed executions of this Action.";
}
leaf last-invocation {
type yang:date-and-time;
config false;
mandatory true;
description
"The date and time of the last invocation of
this Action.";
}
leaf last-completion {
type yang:date-and-time;
config false;
mandatory true;
description
"The date and time of the last completion of
this Action.";
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
}
leaf last-status {
type lmap:status-code;
config false;
mandatory true;
description
"The status code returned by the last execution of
this Action.";
}
leaf last-message {
type string;
config false;
mandatory true;
description
"The status message produced by the last execution
of this Action.";
}
leaf last-failed-completion {
type yang:date-and-time;
config false;
mandatory true;
description
"The date and time of the last failed completion
of this Action.";
}
leaf last-failed-status {
type lmap:status-code;
config false;
mandatory true;
description
"The status code returned by the last failed
execution of this Action.";
}
leaf last-failed-message {
type string;
config false;
mandatory true;
description
"The status message produced by the last failed
execution of this Action.";
}
}
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
}
/*
* Suppression Instructions
*/
container suppressions {
description
"Suppression information to prevent Schedules or
certain Actions from starting.";
list suppression {
key name;
description
"Configuration of a particular Suppression.";
leaf name {
type lmap:identifier;
description
"The locally unique, administratively assigned name
for this Suppression.";
}
leaf start {
type event-ref;
description
"The event source controlling the start of the
Suppression period.";
}
leaf end {
type event-ref;
description
"The event source controlling the end of the
Suppression period. If not present, Suppression
continues indefinitely.";
}
leaf-list match {
type lmap:glob-pattern;
description
"A set of Suppression match patterns. The Suppression
will apply to all Schedules (and their Actions) that
have a matching value in their suppression-tags
and to all Actions that have a matching value in
their suppression-tags.";
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
leaf stop-running {
type boolean;
default false;
description
"If 'stop-running' is true, running Schedules and
Actions matching the Suppression will be terminated
when Suppression is activated. If 'stop-running' is
false, running Schedules and Actions will not be
affected if Suppression is activated.";
}
leaf state {
type enumeration {
enum enabled {
value 1;
description
"The value 'enabled' indicates that the
Suppression is currently enabled.";
}
enum disabled {
value 2;
description
"The value 'disabled' indicates that the
Suppression is currently disabled.";
}
enum active {
value 3;
description
"The value 'active' indicates that the
Suppression is currently active.";
}
}
config false;
mandatory true;
description
"The current state of the Suppression.";
}
}
}
/*
* Event Instructions
*/
container events {
description
"Configuration of LMAP events.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
Implementations may be forced to delay acting
upon the occurrence of events in the face of local
constraints. An Action triggered by an event
therefore should not rely on the accuracy
provided by the scheduler implementation.";
list event {
key name;
description
"The list of event sources configured on the
Measurement Agent.";
leaf name {
type lmap:identifier;
description
"The unique name of an event source.";
}
leaf random-spread {
type uint32;
units seconds;
description
"This optional leaf adds a random spread to the
computation of the event's trigger time. The
random spread is a uniformly distributed random
number taken from the interval [0:random-spread].";
}
leaf cycle-interval {
type uint32;
units seconds;
description
"The optional cycle-interval defines the duration
of the time interval in seconds that is used to
calculate cycle numbers. No cycle number is
calculated if the optional cycle-interval does
not exist.";
}
choice event-type {
description
"Different types of events are handled by
different branches of this choice. Note that
this choice can be extended via augmentations.";
case periodic {
container periodic {
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"A periodic timing object triggers periodically
according to a regular interval.";
leaf interval {
type uint32 {
range "1..max";
}
units "seconds";
mandatory true;
description
"The number of seconds between two triggers
generated by this periodic timing object.";
}
uses start-end-grouping;
}
}
case calendar {
container calendar {
description
"A calendar timing object triggers based on the
current calendar date and time.";
leaf-list month {
type lmap:month-or-all;
min-elements 1;
description
"A set of months at which this calendar timing
will trigger. The wildcard means all months.";
}
leaf-list day-of-month {
type lmap:day-of-months-or-all;
min-elements 1;
description
"A set of days of the month at which this
calendar timing will trigger. The wildcard means
all days of a month.";
}
leaf-list day-of-week {
type lmap:weekday-or-all;
min-elements 1;
description
"A set of weekdays at which this calendar timing
will trigger. The wildcard means all weekdays.";
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
leaf-list hour {
type lmap:hour-or-all;
min-elements 1;
description
"A set of hours at which this calendar timing will
trigger. The wildcard means all hours of a day.";
}
leaf-list minute {
type lmap:minute-or-all;
min-elements 1;
description
"A set of minutes at which this calendar timing
will trigger. The wildcard means all minutes of
an hour.";
}
leaf-list second {
type lmap:second-or-all;
min-elements 1;
description
"A set of seconds at which this calendar timing
will trigger. The wildcard means all seconds of
a minute.";
}
leaf timezone-offset {
type lmap:timezone-offset;
description
"The time zone in which this calendar timing
object will be evaluated. If not present,
the system's local time zone will be used.";
}
uses start-end-grouping;
}
}
case one-off {
container one-off {
description
"A one-off timing object triggers exactly once.";
leaf time {
type yang:date-and-time;
mandatory true;
description
"This one-off timing object triggers once at
the configured date and time.";
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
}
}
}
case immediate {
leaf immediate {
type empty;
mandatory true;
description
"This immediate Event object triggers immediately
when it is configured.";
}
}
case startup {
leaf startup {
type empty;
mandatory true;
description
"This startup Event object triggers whenever the
Measurement Agent (re)starts.";
}
}
case controller-lost {
leaf controller-lost {
type empty;
mandatory true;
description
"The controller-lost Event object triggers when
the connectivity to the Controller has been lost
for at least 'controller-timeout' seconds.";
}
}
case controller-connected {
leaf controller-connected {
type empty;
mandatory true;
description
"The controller-connected Event object triggers
when the connectivity to the Controller has been
restored after it was lost for at least
'controller-timeout' seconds.";
}
}
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
}
}
}
}
<CODE ENDS>
<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. LMAP Report YANG Module</span>
This module imports definitions from [<a href="./rfc6536" title=""Network Configuration Protocol (NETCONF) Access Control Model"">RFC6536</a>] and the common LMAP
module.
<CODE BEGINS> file "ietf-lmap-report@2017-08-08.yang"
module ietf-lmap-report {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-report";
prefix "lmapr";
import ietf-yang-types {
prefix yang;
}
import ietf-lmap-common {
prefix lmap;
}
organization
"IETF Large-Scale Measurement of Broadband Performance
Working Group";
contact
"WG Web: <<a href="https://datatracker.ietf.org/wg/lmap">https://datatracker.ietf.org/wg/lmap</a>>
WG List: <mailto:lmap@ietf.org>
Editor: Juergen Schoenwaelder
<j.schoenwaelder@jacobs-university.de>
Editor: Vaibhav Bajpai
<bajpaiv@in.tum.de>";
description
"This module defines a data model for reporting results from
Measurement Agents, which are part of a Large-Scale Measurement
Platform (LMAP), to result data Collectors. This data model is
expected to be implemented by a Collector.";
revision "2017-08-08" {
description
"Initial version";
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
reference
"<a href="./rfc8194">RFC 8194</a>: A YANG Data Model for LMAP Measurement Agents";
}
rpc report {
description
"The report operation is used by a Measurement Agent to
submit measurement results produced by Measurement Tasks to
a Collector.";
input {
leaf date {
type yang:date-and-time;
mandatory true;
description
"The date and time when this result report was sent to
a Collector.";
}
leaf agent-id {
type yang:uuid;
description
"The agent-id of the agent from which this
report originates.";
}
leaf group-id {
type string;
description
"The group-id of the agent from which this
report originates.";
}
leaf measurement-point {
type string;
description
"The measurement-point of the agent from which this
report originates.";
}
list result {
description
"The list of Tasks for which results are reported.";
leaf schedule {
type lmap:identifier;
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
description
"The name of the Schedule that produced the result.";
}
leaf action {
type lmap:identifier;
description
"The name of the Action in the Schedule that produced
the result.";
}
leaf task {
type lmap:identifier;
description
"The name of the Task that produced the result.";
}
container parameters {
description
"This container is a placeholder for runtime
parameters defined in Task-specific data models
augmenting the base LMAP report data model.";
choice extension {
description
"This choice is provided to augment in different
sets of parameters.";
}
}
uses lmap:options-grouping {
description
"The list of options there were in use when the
measurement was performed. This list must include
both the Task-specific options as well as the
Action-specific options.";
}
leaf-list tag {
type lmap:tag;
description
"A tag contains additional information that is passed
with the result record to the Collector. This is the
joined set of tags defined for the Task object, the
Schedule object, and the Action object. A tag can be
used to carry the Measurement Cycle ID.";
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
leaf event {
type yang:date-and-time;
description
"The date and time of the event that triggered the
Schedule of the Action that produced the reported
result values. The date and time does not include
any added randomization.";
}
leaf start {
type yang:date-and-time;
mandatory true;
description
"The date and time when the Task producing
this result started.";
}
leaf end {
type yang:date-and-time;
description
"The date and time when the Task producing
this result finished.";
}
leaf cycle-number {
type lmap:cycle-number;
description
"The optional cycle number is the time closest to
the time reported in the event leaf that is a multiple
of the cycle-interval of the event that triggered the
execution of the Schedule. The value is only present
if the event that triggered the execution of the
Schedule has a defined cycle-interval.";
}
leaf status {
type lmap:status-code;
mandatory true;
description
"The status code returned by the execution of this
Action.";
}
list conflict {
description
"The names of Tasks overlapping with the execution
of the Task that has produced this result.";
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
leaf schedule-name {
type lmap:identifier;
description
"The name of a Schedule that might have impacted
the execution of the Task that has produced this
result.";
}
leaf action-name {
type lmap:identifier;
description
"The name of an Action within the Schedule that
might have impacted the execution of the Task that
has produced this result.";
}
leaf task-name {
type lmap:identifier;
description
"The name of the Task executed by an Action within
the Schedule that might have impacted the execution
of the Task that has produced this result.";
}
}
list table {
description
"A list of result tables.";
uses lmap:registry-grouping;
leaf-list column {
type string;
description
"An ordered list of column labels. The order is
determined by the system and must match the order
of the columns in the result rows.";
}
list row {
description
"The rows of a result table.";
leaf-list value {
type string;
description
"The value of a cell in the result row.";
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 44]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
}
}
}
}
}
}
<CODE ENDS>
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Security Considerations</span>
The YANG module defined in this document is designed to be accessed
via network management protocols such as NETCONF [<a href="./rfc6241" title=""Network Configuration Protocol (NETCONF)"">RFC6241</a>] or
RESTCONF [<a href="./rfc8040" title=""RESTCONF Protocol"">RFC8040</a>]. The lowest NETCONF layer is the secure transport
layer, and the mandatory-to-implement secure transport is Secure
Shell (SSH) [<a href="./rfc6242" title=""Using the NETCONF Protocol over Secure Shell (SSH)"">RFC6242</a>]. The lowest RESTCONF layer is HTTPS, and the
mandatory-to-implement secure transport is Transport Layer Security
(TLS) [<a href="./rfc5246" title=""The Transport Layer Security (TLS) Protocol Version 1.2"">RFC5246</a>].
The NETCONF access control model [<a href="./rfc6536" title=""Network Configuration Protocol (NETCONF) Access Control Model"">RFC6536</a>] provides the means to
restrict access for particular NETCONF or RESTCONF users to a
preconfigured subset of all available NETCONF or RESTCONF protocol
operations and content.
There are a number of data nodes defined in this YANG module that are
writable/creatable/deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g., edit-config)
to these data nodes without proper protection can have a negative
effect on network operations. These are the subtrees and data nodes
and their sensitivity/vulnerability:
/lmap/agent This subtree configures general properties of
the Measurement Agent such as its identity,
measurement point, or Controller timeout. This
subtree should only have write access for the
system responsible for configuring the
Measurement Agent.
/lmap/tasks This subtree configures the Tasks that can be
invoked by a Controller. This subtree should
only have write access for the system
responsible for configuring the Measurement
Agent. Care must be taken to not expose Tasks
to a Controller that can cause damage to the
system or the network.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 45]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
/lmap/schedules This subtree is used by a Controller to define
the Schedules and Actions that are executed
when certain events occur. Unauthorized access
can cause unwanted load on the device or
network, or it might direct measurement traffic
to targets that become victims of an attack.
/lmap/suppressions This subtree is used by a Controller to define
Suppressions that can temporarily disable the
execution of Schedules or Actions.
Unauthorized access can either disable
measurements that should normally take place or
cause measurements to take place during times
when normally no measurements should take
place.
/lmap/events This subtree is used by a Controller to define
events that trigger the execution of Schedules
and Actions. Unauthorized access can either
disable measurements that should normally take
place or cause measurements to take place
during times when normally no measurements
should take place or at a frequency that is
higher than normally expected.
Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or
notification) to these data nodes. These are the subtrees and data
nodes and their sensitivity/vulnerability:
/lmap/agent This subtree provides information about the
Measurement Agent. This information may be
used to select specific targets for attacks.
/lmap/capabilities This subtree provides information about the
capabilities of the Measurement Agent,
including its software version number and the
Tasks that it supports. This information may
be used to execute targeted attacks against
specific implementations.
/lmap/schedules This subtree provides information about the
Schedules and their associated Actions executed
on the Measurement Agent. This information may
be used to check whether attacks against the
implementation are effective.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 46]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
/lmap/suppressions This subtree provides information about the
Suppressions that can be active on the
Measurement Agent. This information may be
used to predict time periods where measurements
take place (or do not take place).
Some of the RPC operations in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control access to these operations. These are the
operations and their sensitivity/vulnerability:
/report The report operation is used to send locally collected
measurement results to a remote Collector. Unauthorized
access may leak measurement results, including those from
passive measurements.
The data model uses a number of identifiers that are set by the
Controller. Implementors may find these identifiers useful for the
identification of resources, e.g., to identify objects in a file
system providing temporary storage. Since the identifiers used by
the YANG data model may allow characters that may be given special
interpretation in a specific context, implementations must ensure
that identifiers are properly mapped into safe identifiers.
The data model allows specifying options in the form of name/value
pairs that are passed to programs. Implementors ought to take care
that option names and values are passed literally to programs. In
particular, shell expansions that may alter option names and values
must not be performed.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. IANA Considerations</span>
This document registers three URIs in the "IETF XML Registry"
[<a href="./rfc3688" title=""The IETF XML Registry"">RFC3688</a>]. Following the format in <a href="./rfc3688">RFC 3688</a>, the following
registrations have been made.
URI: urn:ietf:params:xml:ns:yang:ietf-lmap-common
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-lmap-control
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-lmap-report
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 47]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
This document registers three YANG modules in the "YANG Module Names"
registry [<a href="./rfc6020" title=""YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)"">RFC6020</a>].
Name: ietf-lmap-common
Namespace: urn:ietf:params:xml:ns:yang:ietf-lmap-common
Prefix: lmap
Reference: <a href="./rfc8194">RFC 8194</a>
Name: ietf-lmap-control
Namespace: urn:ietf:params:xml:ns:yang:ietf-lmap-control
Prefix: lmapc
Reference: <a href="./rfc8194">RFC 8194</a>
Name: ietf-lmap-report
Namespace: urn:ietf:params:xml:ns:yang:ietf-lmap-report
Prefix: lmapr
Reference: <a href="./rfc8194">RFC 8194</a>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. References</span>
<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Normative References</span>
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
DOI 10.17487/RFC2119, March 1997,
<<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>>.
[<a id="ref-RFC5246">RFC5246</a>] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", <a href="./rfc5246">RFC 5246</a>,
DOI 10.17487/RFC5246, August 2008,
<<a href="https://www.rfc-editor.org/info/rfc5246">https://www.rfc-editor.org/info/rfc5246</a>>.
[<a id="ref-RFC6020">RFC6020</a>] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", <a href="./rfc6020">RFC 6020</a>,
DOI 10.17487/RFC6020, October 2010,
<<a href="https://www.rfc-editor.org/info/rfc6020">https://www.rfc-editor.org/info/rfc6020</a>>.
[<a id="ref-RFC6241">RFC6241</a>] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", <a href="./rfc6241">RFC 6241</a>, DOI 10.17487/RFC6241, June 2011,
<<a href="https://www.rfc-editor.org/info/rfc6241">https://www.rfc-editor.org/info/rfc6241</a>>.
[<a id="ref-RFC6242">RFC6242</a>] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", <a href="./rfc6242">RFC 6242</a>, DOI 10.17487/RFC6242, June 2011,
<<a href="https://www.rfc-editor.org/info/rfc6242">https://www.rfc-editor.org/info/rfc6242</a>>.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 48]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
[<a id="ref-RFC6536">RFC6536</a>] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", <a href="./rfc6536">RFC 6536</a>,
DOI 10.17487/RFC6536, March 2012,
<<a href="https://www.rfc-editor.org/info/rfc6536">https://www.rfc-editor.org/info/rfc6536</a>>.
[<a id="ref-RFC6991">RFC6991</a>] Schoenwaelder, J., Ed., "Common YANG Data Types",
<a href="./rfc6991">RFC 6991</a>, DOI 10.17487/RFC6991, July 2013,
<<a href="https://www.rfc-editor.org/info/rfc6991">https://www.rfc-editor.org/info/rfc6991</a>>.
[<a id="ref-RFC7950">RFC7950</a>] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
<a href="./rfc7950">RFC 7950</a>, DOI 10.17487/RFC7950, August 2016,
<<a href="https://www.rfc-editor.org/info/rfc7950">https://www.rfc-editor.org/info/rfc7950</a>>.
[<a id="ref-RFC8040">RFC8040</a>] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", <a href="./rfc8040">RFC 8040</a>, DOI 10.17487/RFC8040, January 2017,
<<a href="https://www.rfc-editor.org/info/rfc8040">https://www.rfc-editor.org/info/rfc8040</a>>.
[<a id="ref-RFC8174">RFC8174</a>] Leiba, B., "Ambiguity of Uppercase vs Lowercase in <a href="./rfc2119">RFC</a>
<a href="./rfc2119">2119</a> Key Words", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc8174">RFC 8174</a>, DOI 10.17487/RFC8174,
May 2017, <<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>>.
[<a id="ref-RFC8193">RFC8193</a>] Burbridge, T., Eardley, P., Bagnulo, M., and J.
Schoenwaelder, "Information Model for Large-Scale
Measurement Platforms (LMAPs)", DOI 10.17487/RFC8193,
<a href="./rfc8193">RFC 8193</a>, August 2017,
<<a href="http://www.rfc-editor.org/info/rfc8193">http://www.rfc-editor.org/info/rfc8193</a>>.
<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Informative References</span>
[<a id="ref-ISO-8601">ISO-8601</a>]
International Organization for Standardization, "Data
elements and interchange formats -- Information
interchange -- Representation of dates and times", ISO
Standard 8601:2004, December 2004.
[<a id="ref-NETCONF-CLIENT-SERVER">NETCONF-CLIENT-SERVER</a>]
Watsen, K., Wu, G., and J. Schoenwaelder, "NETCONF Client
and Server Models", Work in Progress, <a href="./draft-ietf-netconf-netconf-client-server-04">draft-ietf-netconf-</a>
<a href="./draft-ietf-netconf-netconf-client-server-04">netconf-client-server-04</a>, July 2017.
[<a id="ref-RFC3688">RFC3688</a>] Mealling, M., "The IETF XML Registry", <a href="https://www.rfc-editor.org/bcp/bcp81">BCP 81</a>, <a href="./rfc3688">RFC 3688</a>,
DOI 10.17487/RFC3688, January 2004,
<<a href="https://www.rfc-editor.org/info/rfc3688">https://www.rfc-editor.org/info/rfc3688</a>>.
[<a id="ref-RFC5424">RFC5424</a>] Gerhards, R., "The Syslog Protocol", <a href="./rfc5424">RFC 5424</a>,
DOI 10.17487/RFC5424, March 2009,
<<a href="https://www.rfc-editor.org/info/rfc5424">https://www.rfc-editor.org/info/rfc5424</a>>.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 49]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
[<a id="ref-RFC7223">RFC7223</a>] Bjorklund, M., "A YANG Data Model for Interface
Management", <a href="./rfc7223">RFC 7223</a>, DOI 10.17487/RFC7223, May 2014,
<<a href="https://www.rfc-editor.org/info/rfc7223">https://www.rfc-editor.org/info/rfc7223</a>>.
[<a id="ref-RFC7317">RFC7317</a>] Bierman, A. and M. Bjorklund, "A YANG Data Model for
System Management", <a href="./rfc7317">RFC 7317</a>, DOI 10.17487/RFC7317, August
2014, <<a href="https://www.rfc-editor.org/info/rfc7317">https://www.rfc-editor.org/info/rfc7317</a>>.
[<a id="ref-RFC7398">RFC7398</a>] Bagnulo, M., Burbridge, T., Crawford, S., Eardley, P., and
A. Morton, "A Reference Path and Measurement Points for
Large-Scale Measurement of Broadband Performance",
<a href="./rfc7398">RFC 7398</a>, DOI 10.17487/RFC7398, February 2015,
<<a href="https://www.rfc-editor.org/info/rfc7398">https://www.rfc-editor.org/info/rfc7398</a>>.
[<a id="ref-RFC7594">RFC7594</a>] Eardley, P., Morton, A., Bagnulo, M., Burbridge, T.,
Aitken, P., and A. Akhter, "A Framework for Large-Scale
Measurement of Broadband Performance (LMAP)", <a href="./rfc7594">RFC 7594</a>,
DOI 10.17487/RFC7594, September 2015,
<<a href="https://www.rfc-editor.org/info/rfc7594">https://www.rfc-editor.org/info/rfc7594</a>>.
[<a id="ref-W3C.REC-xml-20081126">W3C.REC-xml-20081126</a>]
Bray, T., Paoli, J., Sperberg-McQueen, M., Maler, E., and
F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth
Edition)", World Wide Web Consortium Recommendation REC-
xml-20081126, November 2008,
<<a href="http://www.w3.org/TR/2008/REC-xml-20081126">http://www.w3.org/TR/2008/REC-xml-20081126</a>>.
[<a id="ref-YANG-HARDWARE">YANG-HARDWARE</a>]
Bierman, A., Bjorklund, M., Dong, J., and D. Romascanu, "A
YANG Data Model for Hardware Management", Work in
Progress, <a href="./draft-ietf-netmod-entity-03">draft-ietf-netmod-entity-03</a>, March 2017.
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 50]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. Example Parameter Extension Module</span>
Sometimes Tasks may require complicated parameters that cannot easily
be fit into options, i.e., a list of name/value pairs. In such a
situation, it is possible to augment the ietf-lmap-control.yang and
ietf-lmap-report.yang data models with definitions for more complex
parameters. The following example module demonstrates this idea
using the parameters of UDP latency metrics as an example (although
UDP latency metric parameters do not really need such an extension
module).
module example-ietf-ippm-udp-latency {
namespace "urn:example:ietf-ippm-udp-latency";
prefix "ippm-udp-latency";
import ietf-inet-types {
prefix inet;
}
import ietf-lmap-control {
prefix "lmapc";
}
import ietf-lmap-report {
prefix "lmapr";
}
grouping ippm-udp-latency-parameter-grouping {
leaf src-ip {
type inet:ip-address;
description
"The source IP address of the UDP measurement traffic.";
}
leaf src-port {
type inet:port-number;
description
"The source port number of the UDP measurement traffic.";
}
leaf dst-ip {
type inet:ip-address;
description
"The destination IP address of the UDP measurement traffic.";
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 51]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
leaf dst-port {
type inet:port-number;
description
"The destination port number of the UDP measurement traffic.";
}
leaf poisson-lambda {
type decimal64 {
fraction-digits 4;
}
units "seconds";
default 1.0000;
description
"The average interval for the poisson stream with a resolution
of 0.0001 seconds (0.1 ms).";
}
leaf poisson-limit {
type decimal64 {
fraction-digits 4;
}
units "seconds";
default 30.0000;
description
"The upper limit on the poisson distribution with a resolution
of 0.0001 seconds (0.1 ms).";
}
}
augment "/lmapc:lmap/lmapc:schedules/lmapc:schedule/lmapc:action"
+ "/lmapc:parameters/lmapc:extension" {
description
"This augmentation adds parameters specific to IP Performance
Metrics (IPPM) and UDP latency metrics to Actions.";
case "ietf-ippm-udp-latency" {
uses ippm-udp-latency-parameter-grouping;
}
}
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 52]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
augment "/lmapr:report/lmapr:input/lmapr:result"
+ "/lmapr:parameters/lmapr:extension" {
description
"This augmentation adds parameters specific to IPPM and
UDP latency metrics to reports.";
case "ietf-ippm-udp-latency" {
uses ippm-udp-latency-parameter-grouping;
}
}
}
<span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>. Example Configuration</span>
The configuration below is in XML [<a href="#ref-W3C.REC-xml-20081126">W3C.REC-xml-20081126</a>].
<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<lmap xmlns="urn:ietf:params:xml:ns:yang:ietf-lmap-control">
<agent>
<agent-id>550e8400-e29b-41d4-a716-446655440000</agent-id>
<report-agent-id>true</report-agent-id>
</agent>
<schedules>
<!-- The Schedule S1 first updates a list of ping targets
and subsequently sends a ping to all targets. -->
<schedule>
<name>S1</name>
<start>E1</start>
<execution-mode>sequential</execution-mode>
<action>
<name>A1</name>
<task>update-ping-targets</task>
</action>
<action>
<name>A2</name>
<task>ping-all-targets</task>
<destination>S3</destination>
</action>
<suppression-tag>measurement:ping</suppression-tag>
</schedule>
<!-- The Schedule S2 executes two traceroutes concurrently. -->
<schedule>
<name>S2</name>
<start>E1</start>
<execution-mode>parallel</execution-mode>
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 53]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
<action>
<name>A1</name>
<task>traceroute</task>
<option>
<id>target</id>
<name>target</name>
<value>2001:db8::1</value>
</option>
<destination>S3</destination>
</action>
<action>
<name>A2</name>
<task>traceroute</task>
<option>
<id>target</id>
<name>target</name>
<value>2001:db8::2</value>
</option>
<destination>S3</destination>
</action>
<suppression-tag>measurement:traceroute</suppression-tag>
</schedule>
<!-- The Schedule S3 sends measurement data to a Collector. -->
<schedule>
<name>S3</name>
<start>E2</start>
<action>
<name>A1</name>
<task>report</task>
<option>
<id>collector</id>
<name>collector</name>
<value>https://collector.example.com/</value>
</option>
</action>
</schedule>
</schedules>
<suppressions>
<!-- Stop all measurements if we got orphaned. -->
<suppression>
<name>orphaned</name>
<start>controller-lost</start>
<end>controller-connected</end>
<match>measurement:*</match>
</suppression>
</suppressions>
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 54]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
<tasks>
<!-- configuration of an update-ping-targets task -->
<task>
<name>update-ping-targets</name>
<program>fping-update-targets</program>
</task>
<!-- configuration of a ping-all-targets task -->
<task>
<name>ping-all-targets</name>
<program>fping</program>
</task>
<!-- configuration of a traceroute task -->
<task>
<name>traceroute</name>
<program>mtr</program>
<option>
<id>csv</id>
<name>--csv</name>
</option>
</task>
<!-- configuration of a reporter task -->
<task>
<name>report</name>
<program>lmap-report</program>
</task>
<task>
<name>ippm-udp-latency-client</name>
<program>ippm-udp-latency</program>
<function>
<uri>urn:example:tbd</uri>
<role>client</role>
</function>
<tag>active</tag>
</task>
</tasks>
<events>
<!-- The event E1 triggers every hour during September 2016
with a random spread of one minute. -->
<event>
<name>E1</name>
<random-spread>60</random-spread> <!-- seconds -->
<periodic>
<interval>3600000</interval>
<start>2016-09-01T00:00:00+00:00</start>
<end>2016-11-01T00:00:00+00:00</end>
</periodic>
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 55]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
</event>
<!-- The event E2 triggers on Mondays at 4am UTC -->
<event>
<name>E2</name>
<calendar>
<month>*</month>
<day-of-week>monday</day-of-week>
<day-of-month>*</day-of-month>
<hour>4</hour>
<minute>0</minute>
<second>0</second>
<timezone-offset>+00:00</timezone-offset>
</calendar>
</event>
<!-- The event controller-lost triggers when we lost
connectivity with the Controller. -->
<event>
<name>controller-lost</name>
<controller-lost/>
</event>
<!-- The event contoller-connected triggers when we
established or re-established connectivity with
the Controller. -->
<event>
<name>controller-connected</name>
<controller-connected/>
</event>
</events>
</lmap>
</config>
<span class="h2"><a class="selflink" id="appendix-C" href="#appendix-C">Appendix C</a>. Example Report</span>
The report below is in XML [<a href="#ref-W3C.REC-xml-20081126">W3C.REC-xml-20081126</a>].
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
message-id="1">
<report xmlns="urn:ietf:params:xml:ns:yang:ietf-lmap-report">
<date>2015-10-28T13:27:42+02:00</date>
<agent-id>550e8400-e29b-41d4-a716-446655440000</agent-id>
<result>
<schedule>S1</schedule>
<action>A1</action>
<task>update-ping-targets</task>
<start>2016-03-21T10:48:55+01:00</start>
<end>2016-03-21T10:48:57+01:00</end>
<status>0</status>
</result>
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 56]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
<result>
<schedule>S1</schedule>
<action>A2</action>
<task>ping-all-targets</task>
<start>2016-03-21T10:48:55+01:00</start>
<end>2016-03-21T10:48:57+01:00</end>
<status>0</status>
<table>
<column>target</column>
<column>rtt</column>
<row>
<value>2001:db8::1</value>
<value>42</value>
</row>
<row>
<value>2001:db8::2</value>
<value>24</value>
</row>
</table>
</result>
<result>
<schedule>S2</schedule>
<action>A1</action>
<task>traceroute</task>
<option>
<id>target</id>
<name>target</name>
<value>2001:db8::1</value>
</option>
<option>
<id>csv</id>
<name>--csv</name>
</option>
<start>2016-03-21T10:48:55+01:00</start>
<end>2016-03-21T10:48:57+01:00</end>
<status>1</status>
<table>
<column>hop</column>
<column>ip</column>
<column>rtt</column>
<row>
<value>1</value>
<value>2001:638:709:5::1</value>
<value>10.5</value>
</row>
<row>
<value>2</value>
<value>?</value>
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 57]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
<value></value>
</row>
</table>
</result>
<result>
<schedule>S2</schedule>
<action>A2</action>
<task>traceroute</task>
<option>
<id>target</id>
<name>target</name>
<value>2001:db8::2</value>
</option>
<option>
<id>csv</id>
<name>--csv</name>
</option>
<start>2016-03-21T10:48:55+01:00</start>
<end>2016-03-21T10:48:57+01:00</end>
<status>1</status>
<table>
<column>hop</column>
<column>ip</column>
<column>rtt</column>
<row>
<value>1</value>
<value>2001:638:709:5::1</value>
<value>11.8</value>
</row>
<row>
<value>2</value>
<value>?</value>
<value></value>
</row>
</table>
</result>
</report>
</rpc>
<span class="grey">Schoenwaelder & Bajpai Standards Track [Page 58]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
<span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
Acknowledgements
Several people contributed to this specification by reviewing early
draft versions and actively participating in the LMAP Working Group
(apologies to those unintentionally omitted): Marcelo Bagnulo, Martin
Bjorklund, Trevor Burbridge, Timothy Carey, Alissa Cooper, Philip
Eardley, Al Morton, Dan Romascanu, Andrea Soppera, Barbara Stark, and
Qin Wu.
Juergen Schoenwaelder and Vaibhav Bajpai worked in part on the Leone
research project, which received funding from the European Union
Seventh Framework Programme [FP7/2007-2013] under grant agreement
number 317647.
Juergen Schoenwaelder and Vaibhav Bajpai were partly funded by
Flamingo, a Network of Excellence project (ICT-318488) supported by
the European Commission under its Seventh Framework Programme.
Authors' Addresses
Juergen Schoenwaelder
Jacobs University Bremen
Email: j.schoenwaelder@jacobs-university.de
Vaibhav Bajpai
Technical University of Munich
Email: bajpaiv@in.tum.de
Schoenwaelder & Bajpai Standards Track [Page 59]
</pre>
|