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
|
<pre>Internet Engineering Task Force (IETF) H. Asai
Request for Comments: 7666 Univ. of Tokyo
Category: Standards Track M. MacFaden
ISSN: 2070-1721 VMware Inc.
J. Schoenwaelder
Jacobs University
K. Shima
IIJ Innovation Institute Inc.
T. Tsou
Huawei Technologies (USA)
October 2015
<span class="h1">Management Information Base for Virtual Machines</span>
<span class="h1">Controlled by a Hypervisor</span>
Abstract
This document defines a portion of the Management Information Base
(MIB) for use with network management protocols in the Internet
community. In particular, this specifies objects for managing
virtual machines controlled by a hypervisor (a.k.a. virtual machine
monitor).
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="./rfc5741#section-2">Section 2 of RFC 5741</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/rfc7666">http://www.rfc-editor.org/info/rfc7666</a>.
<span class="grey">Asai, et al. Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
Copyright Notice
Copyright (c) 2015 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.
Table of Contents
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
<a href="#section-2">2</a>. The Internet-Standard Management Framework . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-3">3</a>. Overview and Objectives . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-4">4</a>. Structure of the VM-MIB Module . . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-5">5</a>. Relationship to Other MIB Modules . . . . . . . . . . . . . . <a href="#page-7">7</a>
<a href="#section-6">6</a>. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-6.1">6.1</a>. VM-MIB . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-6.2">6.2</a>. IANA-STORAGE-MEDIA-TYPE-MIB . . . . . . . . . . . . . . . <a href="#page-43">43</a>
<a href="#section-7">7</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-45">45</a>
<a href="#section-8">8</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-45">45</a>
<a href="#section-9">9</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-46">46</a>
<a href="#section-9.1">9.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-46">46</a>
<a href="#section-9.2">9.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-47">47</a>
<a href="#appendix-A">Appendix A</a>. State Transition Table . . . . . . . . . . . . . . . <a href="#page-49">49</a>
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-51">51</a>
Contributors . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-51">51</a>
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-52">52</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
This document defines a portion of the Management Information Base
(MIB) for use with network management protocols in the Internet
community. In particular, this specifies objects for managing
virtual machines controlled by a hypervisor (a.k.a. virtual machine
monitor). A hypervisor controls multiple virtual machines on a
single physical machine by allocating resources to each virtual
machine using virtualization technologies. Therefore, this MIB
module contains information on virtual machines and their resources
controlled by a hypervisor as well as information about a
hypervisor's hardware and software.
<span class="grey">Asai, et al. Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
The design of this MIB module has been derived from product-specific
MIB modules -- namely, a MIB module for managing guests of the Xen
hypervisor [<a href="#ref-Xen" title=""The Xen Hypervisor"">Xen</a>], a MIB module for managing virtual machines
controlled by the VMware hypervisor [<a href="#ref-VMware" title=""The VMware Hypervisor"">VMware</a>], and a MIB module using
the libvirt programming interface [<a href="#ref-libvirt" title=""The libvirt virtialization API"">libvirt</a>] to access different
hypervisors. However, this MIB module attempts to generalize the
managed objects to support other implementations of hypervisors.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in <a href="./rfc2119">RFC 2119</a> [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>].
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. The Internet-Standard Management Framework</span>
For a detailed overview of the documents that describe the current
Internet-Standard Management Framework, please refer to <a href="./rfc3410#section-7">section 7 of
RFC 3410</a> [<a href="./rfc3410" title=""Introduction and Applicability Statements for Internet- Standard Management Framework"">RFC3410</a>].
Managed objects are accessed via a virtual information store, termed
the Management Information Base or MIB. MIB objects are generally
accessed through the Simple Network Management Protocol (SNMP).
Objects in the MIB are defined using the mechanisms defined in the
Structure of Management Information (SMI). This memo specifies a MIB
module that is compliant to the SMIv2, which is described in STD 58,
<a href="./rfc2578">RFC 2578</a> [<a href="./rfc2578" title=""Structure of Management Information Version 2 (SMIv2)"">RFC2578</a>], STD 58, <a href="./rfc2579">RFC 2579</a> [<a href="./rfc2579" title=""Textual Conventions for SMIv2"">RFC2579</a>] and STD 58, <a href="./rfc2580">RFC 2580</a>
[<a href="./rfc2580" title=""Conformance Statements for SMIv2"">RFC2580</a>].
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Overview and Objectives</span>
This document defines a portion of MIB for the management of virtual
machines controlled by a hypervisor. This MIB module consists of the
managed objects related to system and software information of a
hypervisor, the list of virtual machines controlled by the
hypervisor, and information of virtual resources allocated to virtual
machines by the hypervisor. This document specifies four specific
types of virtual resources that are common to many hypervisor
implementations: processors (CPUs), memory, network interfaces
(NICs), and storage devices. These managed objects are independent
of the families of hypervisors or operating systems running on
virtual machines.
<span class="grey">Asai, et al. Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
+------------------------------------------------------------------+
| +-------------------------------------------------+ |
| | Virtual machine | |
| | | |
| | +---------+ +---------+ +---------+ +---------+ | ....... |
| | | Virtual | | Virtual | | Virtual | | Virtual | | |
| +-| CPU |-| memory |-| storage |-| NIC |-+ |
| +---------+ +---------+ +---------+ +---------+ |
| Virtual resources |
| ^ |
| | Allocation using virtualization technologies |
| | |
| +-- Physical resources ._____. |
| +--------+ .--------. / \ +--^--+ |
+- - - - - - - | | - /________/| - *\_______/* - | | - -+
| Hypervisor | CPU | | Memory |/ | Storage | | NIC | |
| +--------+ +--------+ \_______/ +-----+ |
| +-----------------------+ |
| || MIB objects || |
| +-----------------------+ |
+------------------------------------------------------------------+
Figure 1: An Example of a Virtualization Environment
On the common implementations of hypervisors, a hypervisor allocates
virtual resources from physical resources: virtual CPUs, virtual
memory, virtual storage devices, and virtual network interfaces to
virtual machines as shown in Figure 1. Since the virtual resources
allocated to virtual machines are managed by the hypervisor, the MIB
objects are managed at the hypervisor. In case that the objects are
accessed through the SNMP, an SNMP agent is launched at the
hypervisor to provide access to the objects.
The objects are managed from the viewpoint of the operators of
hypervisors, but not the operators of virtual machines; that is, the
objects do not take into account the actual resource utilization on
each virtual machine but rather the resource allocation from the
physical resources. For example, vmNetworkIfIndex indicates the
virtual interface associated with an interface of a virtual machine
at the hypervisor, and consequently, the 'in' and 'out' directions
denote 'from a virtual machine to the hypervisor' and 'from the
hypervisor to a virtual machine', respectively. Moreover,
vmStorageAllocatedSize denotes the size allocated by the hypervisor,
but not the size actually used by the operating system on the virtual
machine. This means that vmStorageDefinedSize and
vmStorageAllocatedSize do not take different values when the
vmStorageSourceType is 'block' or 'raw'.
<span class="grey">Asai, et al. Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
The objectives of this document are the following: 1) this document
defines the MIB objects common to many hypervisors for the management
of virtual machines controlled by a hypervisor, and 2) this document
clarifies the relationship with other MIB modules for managing host
computers and network devices.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Structure of the VM-MIB Module</span>
The MIB module is organized into a group of scalars and tables. The
scalars below 'vmHypervisor' provide basic information about the
hypervisor. The 'vmTable' lists the virtual machines (guests) that
are known to the hypervisor. The 'vmCpuTable' provides the mapping
table of virtual CPUs to virtual machines, including CPU time used by
each virtual CPU. The 'vmCpuAffinityTable' provides the affinity of
each virtual CPU to a physical CPU. The 'vmStorageTable' provides
the list of virtual storage devices and their mapping to virtual
machines. In case that an entry in the 'vmStorageTable' has a
corresponding parent physical storage device managed in
'vmStorageTable' of HOST-RESOURCES-MIB [<a href="./rfc2790" title=""Host Resources MIB"">RFC2790</a>], the entry contains
a pointer 'vmStorageParent' to the physical storage device. The
'vmNetworkTable' provides the list of virtual network interfaces and
their mapping to virtual machines. Each entry in the
'vmNetworkTable' also provides a pointer 'vmNetworkIfIndex' to the
corresponding entry in the 'ifTable' of IF-MIB [<a href="./rfc2863" title=""The Interfaces Group MIB"">RFC2863</a>]. In case
that an entry in the 'vmNetworkTable' has a corresponding parent
physical network interface managed in the 'ifTable' of IF-MIB, the
entry contains a pointer 'vmNetworkParent' to the physical network
interface.
<span class="grey">Asai, et al. Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
Notation:
+-------------+
| vmOperState | : Finite state; the first line presents the
| | 'vmOperState', and the second line presents a
+-------------+ notification generated if applicable.
+ - - - - - - +
| vmOperState | : Transient state; first line presents the
| | 'vmOperState', and the second line presents a
+ - - - - - - + notification generated if applicable.
! : Notification; a text followed by the symbol "!"
denotes a notification generated.
=====================================================================
+---------------+ + - - - - - - - -+ +------------+
| suspended(6) |<--| suspending(5) | | paused(8) |
| !vmSuspended | | !vmSuspending | | !vmPaused |
+---------------+ + - - - - - - - -+ +------------+
| ^ ^
| | |
v | |
+ - - - - - - -+ +-------------+<----------+ + - - - - - - - +
| resuming(7) |-->| running(4) |<-------------->| migrating(9) |
| !vmResuming | | !vmRunning | | !vmMigrating |
+ - - - - - - -+ +-------------+ + - - - - - - - +
| ^ ^
| | |
| +-------------------+ |
| | |
v v v
+ - - - - - - - - - + +---------------+
| shuttingdown(10) |--------->| shutdown(11) |
| !vmShuttingdown | | !vmShutdown |
+ - - - - - - - - - + +---------------+
^ |
| v !vmDeleted
+--------------+ + - - - - - - - -+ (Deleted from
| crashed(12) | | preparing(3) | vmTable)
| !vmCrashed | | |
+--------------+ + - - - - - - - -+
Figure 2: State Transition of a Virtual Machine
<span class="grey">Asai, et al. Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
The 'vmAdminState' and 'vmOperState' textual conventions define an
administrative state and an operational state model for virtual
machines. Events causing transitions between major operational
states will cause the generation of notifications. Per virtual
machine (per-VM) notifications (vmRunning, vmShutdown, vmPaused,
vmSuspended, vmCrashed, vmDeleted) are generated if
vmPerVMNotificationsEnabled is true(1). Bulk notifications
(vmBulkRunning, vmBulkShutdown, vmBulkPaused, vmBulkSuspended,
vmBulkCrashed, vmBulkDeleted) are generated if
vmBulkNotificationsEnabled is true(1). The overview of the
transition of 'vmOperState' by the write access to 'vmAdminState' and
the notifications generated by the operational state changes are
illustrated in Figure 2. The detailed state transition is summarized
in <a href="#appendix-A">Appendix A</a>. Note that the notifications shown in this figure are
per-VM notifications. In the case of Bulk notifications, the prefix
'vm' is replaced with 'vmBulk'.
The bulk notification mechanism is designed to reduce the number of
notifications that are trapped by an SNMP manager. This is because
the number of virtual machines managed by a bunch of hypervisors in a
data center possibly becomes several thousands or more, and
consequently, many notifications could be trapped if these virtual
machines frequently change their administrative state. The per-VM
notifications carry more detailed information, but the scalability is
a problem. The notification filtering mechanism described in
<a href="./rfc3413#section-6">Section 6 of RFC 3413</a> [<a href="./rfc3413" title=""Simple Network Management Protocol (SNMP) Applications"">RFC3413</a>] is used by the management
applications to control the notifications.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Relationship to Other MIB Modules</span>
The HOST-RESOURCES-MIB [<a href="./rfc2790" title=""Host Resources MIB"">RFC2790</a>] defines the MIB objects for managing
host systems. On systems implementing the HOST-RESOURCES-MIB, the
objects of HOST-RESOURCES-MIB indicate resources of a hypervisor.
Some objects of HOST-RESOURCES-MIB are used to indicate physical
resources through indexes. On systems implementing
HOST-RESOURCES-MIB, the 'vmCpuPhysIndex' points to the processor's
'hrDeviceIndex' in the 'hrProcessorTable'. The 'vmStorageParent'
also points to the storage device's 'hrStorageIndex' in the
'hrStorageTable'.
The IF-MIB [<a href="./rfc2863" title=""The Interfaces Group MIB"">RFC2863</a>] defines the MIB objects for managing network
interfaces. Both physical and virtual network interfaces are
required to be contained in the 'ifTable' of IF-MIB. The virtual
network interfaces in the 'ifTable' of IF-MIB are pointed from the
'vmNetworkTable' defined in this document through a pointer
'vmNetworkIfIndex'. In case that an entry in the 'vmNetworkTable'
<span class="grey">Asai, et al. Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
has a corresponding parent physical network interface managed in the
'ifTable' of IF-MIB, the entry contains a pointer 'vmNetworkParent'
to the physical network interface.
The objects related to virtual switches are not included in the MIB
module defined in this document though virtual switches MAY be placed
on a hypervisor. This is because the virtual network interfaces are
the lowest abstraction of network resources allocated to a virtual
machine. Instead of including the objects related to virtual
switches, for example, IEEE8021-BRIDGE-MIB [<a href="#ref-IEEE8021-BRIDGE-MIB">IEEE8021-BRIDGE-MIB</a>] and
IEEE8021-Q-BRIDGE-MIB [<a href="#ref-IEEE8021-Q-BRIDGE-MIB">IEEE8021-Q-BRIDGE-MIB</a>] could be used.
The other objects related to virtual machines such as management IP
addresses of a virtual machine are not included in this MIB module
because this MIB module defines the objects common to general
hypervisors, but they are specific to some hypervisors. They may be
included in the entLogicalTable of ENTITY-MIB [<a href="./rfc6933" title=""Entity MIB (Version 4)"">RFC6933</a>].
The SNMPv2-MIB [<a href="./rfc3418" title=""Management Information Base (MIB) for the Simple Network Management Protocol (SNMP)"">RFC3418</a>] provides an object 'sysObjectID' that
identifies the network management subsytem and an object 'sysUpTime'
that reports the uptime of the network management portion of the
system. The HOST-RESOURCES-MIB [<a href="./rfc2790" title=""Host Resources MIB"">RFC2790</a>] provides an object
'hrSystemUptime' that reports the uptime of the host's operating
system. To complement these objects, the new 'vmHvUpTime' object
reports the time since the hypervisor was last re-initialized, and
the new 'vmHvObjectID' provides an identification of the hypervisor
software.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Definitions</span>
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. VM-MIB</span>
VM-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, TimeTicks,
Counter64, Integer32, mib-2
FROM SNMPv2-SMI
OBJECT-GROUP, MODULE-COMPLIANCE, NOTIFICATION-GROUP
FROM SNMPv2-CONF
TEXTUAL-CONVENTION, PhysAddress, TruthValue
FROM SNMPv2-TC
SnmpAdminString
FROM SNMP-FRAMEWORK-MIB
UUIDorZero
FROM UUID-TC-MIB
InterfaceIndexOrZero
FROM IF-MIB
<span class="grey">Asai, et al. Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
IANAStorageMediaType
FROM IANA-STORAGE-MEDIA-TYPE-MIB;
vmMIB MODULE-IDENTITY
LAST-UPDATED "201510120000Z" -- 12 October 2015
ORGANIZATION "IETF Operations and Management Area Working Group"
CONTACT-INFO
"WG Email: opsawg@ietf.org
Mailing list subscription info:
<a href="https://www.ietf.org/mailman/listinfo/opsawg">https://www.ietf.org/mailman/listinfo/opsawg</a>
Hirochika Asai
The University of Tokyo
7-3-1 Hongo
Bunkyo-ku, Tokyo 113-8656
Japan
Phone: +81 3 5841 6748
Email: panda@hongo.wide.ad.jp
Michael MacFaden
VMware Inc.
Email: mrm@vmware.com
Juergen Schoenwaelder
Jacobs University
Campus Ring 1
Bremen 28759
Germany
Email: j.schoenwaelder@jacobs-university.de
Keiichi Shima
IIJ Innovation Institute Inc.
3-13 Kanda-Nishikicho
Chiyoda-ku, Tokyo 101-0054
Japan
Email: keiichi@iijlab.net
Tina Tsou
Huawei Technologies (USA)
2330 Central Expressway
Santa Clara, CA 95050
United States
Email: tina.tsou.zouting@huawei.com"
DESCRIPTION
"This MIB module is for use in managing a hypervisor and
virtual machines controlled by the hypervisor.
<span class="grey">Asai, et al. Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
Copyright (c) 2015 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the
Simplified BSD License set forth in <a href="#section-4">Section 4</a>.c of 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>)."
REVISION "201510120000Z" -- 12 October 2015
DESCRIPTION
"The initial version of this MIB, published as
<a href="./rfc7666">RFC 7666</a>."
::= { mib-2 236 }
vmNotifications OBJECT IDENTIFIER ::= { vmMIB 0 }
vmObjects OBJECT IDENTIFIER ::= { vmMIB 1 }
vmConformance OBJECT IDENTIFIER ::= { vmMIB 2 }
-- Textual conversion definitions
--
VirtualMachineIndex ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"A unique value, greater than zero, identifying a
virtual machine. The value for each virtual machine
MUST remain constant at least from one re-initialization
of the hypervisor to the next re-initialization."
SYNTAX Integer32 (1..2147483647)
VirtualMachineIndexOrZero ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"This textual convention is an extension of the
VirtualMachineIndex convention. This extension permits
the additional value of zero. The meaning of the value
zero is object-specific and MUST therefore be defined as
part of the description of any object that uses this
syntax. Examples of the usage of zero might include
situations where a virtual machine is unknown, or when
none or all virtual machines need to be referenced."
SYNTAX Integer32 (0..2147483647)
VirtualMachineAdminState ::= TEXTUAL-CONVENTION
<span class="grey">Asai, et al. Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
STATUS current
DESCRIPTION
"The administrative state of a virtual machine:
running(1) The administrative state of the virtual
machine indicating the virtual machine
is currently online or should be brought
online.
suspended(2) The administrative state of the virtual
machine where its memory and CPU execution
state has been saved to persistent store
and will be restored at next running(1).
paused(3) The administrative state indicating the
virtual machine is resident in memory but
is no longer scheduled to execute by the
hypervisor.
shutdown(4) The administrative state of the virtual
machine indicating the virtual machine
is currently offline or should be
shutting down."
SYNTAX INTEGER {
running(1),
suspended(2),
paused(3),
shutdown(4)
}
VirtualMachineOperState ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The operational state of a virtual machine:
unknown(1) The operational state of the virtual
machine is unknown, e.g., because the
implementation failed to obtain the state
from the hypervisor.
other(2) The operational state of the virtual
machine indicating that an operational
state is obtained from the hypervisor, but
it is not a state defined in this MIB
module.
preparing(3) The operational state of the virtual
machine indicating the virtual machine is
<span class="grey">Asai, et al. Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
currently in the process of preparation,
e.g., allocating and initializing virtual
storage after creating (defining) the
virtual machine.
running(4) The operational state of the virtual
machine indicating the virtual machine is
currently executed, but it is not in the
process of preparing(3), suspending(5),
resuming(7), migrating(9), and
shuttingdown(10).
suspending(5) The operational state of the virtual
machine indicating the virtual machine is
currently in the process of suspending
to save its memory and CPU execution
state to persistent store. This is a
transient state from running(4) to
suspended(6).
suspended(6) The operational state of the virtual
machine indicating the virtual machine is
currently suspended, which means the
memory and CPU execution state of the
virtual machine are saved to persistent
store. During this state, the virtual
machine is not scheduled to execute by
the hypervisor.
resuming(7) The operational state of the virtual
machine indicating the virtual machine is
currently in the process of resuming
to restore its memory and CPU execution
state from persistent store. This is a
transient state from suspended(6) to
running(4).
paused(8) The operational state of the virtual
machine indicating the virtual machine is
resident in memory but no longer
scheduled to execute by the hypervisor.
migrating(9) The operational state of the virtual
machine indicating the virtual machine is
currently in the process of migration
from/to another hypervisor.
shuttingdown(10)
<span class="grey">Asai, et al. Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
The operational state of the virtual
machine indicating the virtual machine is
currently in the process of shutting
down. This is a transient state from
running(4) to shutdown(11).
shutdown(11) The operational state of the virtual
machine indicating the virtual machine is
down, and CPU execution is no longer
scheduled by the hypervisor and its
memory is not resident in the hypervisor.
crashed(12) The operational state of the virtual
machine indicating the virtual machine
has crashed."
SYNTAX INTEGER {
unknown(1),
other(2),
preparing(3),
running(4),
suspending(5),
suspended(6),
resuming(7),
paused(8),
migrating(9),
shuttingdown(10),
shutdown(11),
crashed(12)
}
VirtualMachineAutoStart ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The autostart configuration of a virtual machine:
unknown(1) The autostart configuration is unknown,
e.g., because the implementation failed
to obtain the autostart configuration
from the hypervisor.
enabled(2) The autostart configuration of the
virtual machine is enabled. The virtual
machine should be automatically brought
online at the next re-initialization of
the hypervisor.
disabled(3) The autostart configuration of the
virtual machine is disabled. The virtual
<span class="grey">Asai, et al. Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
machine should not be automatically
brought online at the next
re-initialization of the hypervisor."
SYNTAX INTEGER {
unknown(1),
enabled(2),
disabled(3)
}
VirtualMachinePersistent ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This value indicates whether a virtual machine has a
persistent configuration, which means the virtual machine
will still exist after shutting down:
unknown(1) The persistent configuration is unknown,
e.g., because the implementation failed
to obtain the persistent configuration
from the hypervisor. (read-only)
persistent(2) The virtual machine is persistent, i.e.,
the virtual machine will exist after it
shuts down.
transient(3) The virtual machine is transient, i.e.,
the virtual machine will not exist after
it shuts down."
SYNTAX INTEGER {
unknown(1),
persistent(2),
transient(3)
}
VirtualMachineCpuIndex ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"A unique value for each virtual machine, greater than
zero, identifying a virtual CPU assigned to a virtual
machine. The value for each virtual CPU MUST remain
constant at least from one re-initialization of the
hypervisor to the next re-initialization."
SYNTAX Integer32 (1..2147483647)
VirtualMachineStorageIndex ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
<span class="grey">Asai, et al. Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
DESCRIPTION
"A unique value for each virtual machine, greater than
zero, identifying a virtual storage device allocated to
a virtual machine. The value for each virtual storage
device MUST remain constant at least from one
re-initialization of the hypervisor to the next
re-initialization."
SYNTAX Integer32 (1..2147483647)
VirtualMachineStorageSourceType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The source type of a virtual storage device:
unknown(1) The source type is unknown, e.g., because
the implementation failed to obtain the
media type from the hypervisor.
other(2) The source type is other than those
defined in this conversion.
block(3) The source type is a block device.
raw(4) The source type is a raw-formatted file.
sparse(5) The source type is a sparse file.
network(6) The source type is a network device."
SYNTAX INTEGER {
unknown(1),
other(2),
block(3),
raw(4),
sparse(5),
network(6)
}
VirtualMachineStorageAccess ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The access permission of a virtual storage:
unknown(1) The access permission of the virtual
storage is unknown.
readwrite(2) The virtual storage is a read-write
device.
<span class="grey">Asai, et al. Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
readonly(3) The virtual storage is a read-only
device."
SYNTAX INTEGER {
unknown(1),
readwrite(2),
readonly(3)
}
VirtualMachineNetworkIndex ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"A unique value for each virtual machine, greater than
zero, identifying a virtual network interface allocated
to the virtual machine. The value for each virtual
network interface MUST remain constant at least from one
re-initialization of the hypervisor to the next
re-initialization."
SYNTAX Integer32 (1..2147483647)
VirtualMachineList ::= TEXTUAL-CONVENTION
DISPLAY-HINT "1x"
STATUS current
DESCRIPTION
"Each octet within this value specifies a set of eight
virtual machine vmIndex values, with the first octet
specifying virtual machine 1 through 8, the second octet
specifying virtual machine 9 through 16, etc. Within
each octet, the most significant bit represents the
lowest-numbered vmIndex, and the least significant bit
represents the highest-numbered vmIndex. Thus, each
virtual machine of the host is represented by a single
bit within the value of this object. If that bit has
a value of '1', then that virtual machine is included
in the set of virtual machines; the virtual machine is
not included if its bit has a value of '0'."
SYNTAX OCTET STRING
-- The hypervisor group
--
-- A collection of objects common to all hypervisors.
--
vmHypervisor OBJECT IDENTIFIER ::= { vmObjects 1 }
vmHvSoftware OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
<span class="grey">Asai, et al. Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
DESCRIPTION
"A textual description of the hypervisor software. This
value SHOULD NOT include its version as it SHOULD be
included in 'vmHvVersion'."
::= { vmHypervisor 1 }
vmHvVersion OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A textual description of the version of the hypervisor
software."
::= { vmHypervisor 2 }
vmHvObjectID OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The vendor's authoritative identification of the
hypervisor software contained in the entity. This value
is allocated within the SMI enterprises
subtree (1.3.6.1.4.1). Note that this is different from
sysObjectID in the SNMPv2-MIB (<a href="./rfc3418">RFC 3418</a>) because
sysObjectID is not the identification of the hypervisor
software but the device, firmware, or management
operating system."
::= { vmHypervisor 3 }
vmHvUpTime OBJECT-TYPE
SYNTAX TimeTicks
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The time (in centiseconds) since the hypervisor was
last re-initialized. Note that this is different from
sysUpTime in the SNMPv2-MIB (<a href="./rfc3418">RFC 3418</a>) and hrSystemUptime
in the HOST-RESOURCES-MIB (<a href="./rfc2790">RFC 2790</a>) because sysUpTime is
the uptime of the network management portion of the
system, and hrSystemUptime is the uptime of the
management operating system but not the hypervisor
software."
::= { vmHypervisor 4 }
-- The virtual machine information
--
<span class="grey">Asai, et al. Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
-- A collection of objects common to all virtual machines.
--
vmNumber OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of virtual machines (regardless of their
current state) present on this hypervisor."
::= { vmObjects 2 }
vmTableLastChange OBJECT-TYPE
SYNTAX TimeTicks
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of vmHvUpTime at the time of the last creation
or deletion of an entry in the vmTable."
::= { vmObjects 3 }
vmTable OBJECT-TYPE
SYNTAX SEQUENCE OF VmEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A list of virtual machine entries. The number of
entries is given by the value of vmNumber."
::= { vmObjects 4 }
vmEntry OBJECT-TYPE
SYNTAX VmEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry containing management information applicable
to a particular virtual machine."
INDEX { vmIndex }
::= { vmTable 1 }
VmEntry ::=
SEQUENCE {
vmIndex VirtualMachineIndex,
vmName SnmpAdminString,
vmUUID UUIDorZero,
vmOSType SnmpAdminString,
vmAdminState VirtualMachineAdminState,
vmOperState VirtualMachineOperState,
vmAutoStart VirtualMachineAutoStart,
<span class="grey">Asai, et al. Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
vmPersistent VirtualMachinePersistent,
vmCurCpuNumber Integer32,
vmMinCpuNumber Integer32,
vmMaxCpuNumber Integer32,
vmMemUnit Integer32,
vmCurMem Integer32,
vmMinMem Integer32,
vmMaxMem Integer32,
vmUpTime TimeTicks,
vmCpuTime Counter64
}
vmIndex OBJECT-TYPE
SYNTAX VirtualMachineIndex
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique value, greater than zero, identifying the
virtual machine. The value assigned to a given virtual
machine may not persist across re-initialization of the
hypervisor. A command generator MUST use the vmUUID to
identify a given virtual machine of interest."
::= { vmEntry 1 }
vmName OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A textual name of the virtual machine."
::= { vmEntry 2 }
vmUUID OBJECT-TYPE
SYNTAX UUIDorZero
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The virtual machine's 128-bit Universally Unique
Identifier (UUID) or the zero-length string when a
UUID is not available. If set, the UUID MUST uniquely
identify a virtual machine from all other virtual
machines in an administrative domain. A zero-length
octet string is returned if no UUID information is
known."
::= { vmEntry 3 }
vmOSType OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
<span class="grey">Asai, et al. Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A textual description containing operating system
information installed on the virtual machine. This
value corresponds to the operating system the hypervisor
assumes to be running when the virtual machine is
started. This may differ from the actual operating
system in case the virtual machine boots into a
different operating system."
::= { vmEntry 4 }
vmAdminState OBJECT-TYPE
SYNTAX VirtualMachineAdminState
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The administrative state of the virtual machine."
::= { vmEntry 5 }
vmOperState OBJECT-TYPE
SYNTAX VirtualMachineOperState
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The operational state of the virtual machine."
::= { vmEntry 6 }
vmAutoStart OBJECT-TYPE
SYNTAX VirtualMachineAutoStart
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The autostart configuration of the virtual machine. If
this value is enable(2), the virtual machine
automatically starts at the next initialization of the
hypervisor."
::= { vmEntry 7 }
vmPersistent OBJECT-TYPE
SYNTAX VirtualMachinePersistent
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This value indicates whether the virtual machine has a
persistent configuration, which means the virtual machine
will still exist after its shutdown."
::= { vmEntry 8 }
<span class="grey">Asai, et al. Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
vmCurCpuNumber OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of virtual CPUs currently assigned to the
virtual machine."
::= { vmEntry 9 }
vmMinCpuNumber OBJECT-TYPE
SYNTAX Integer32 (-1|0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The minimum number of virtual CPUs that are assigned to
the virtual machine when it is in a power-on state. The
value -1 indicates that there is no hard boundary for
the minimum number of virtual CPUs."
::= { vmEntry 10 }
vmMaxCpuNumber OBJECT-TYPE
SYNTAX Integer32 (-1|0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The maximum number of virtual CPUs that are assigned to
the virtual machine when it is in a power-on state. The
value -1 indicates that there is no limit."
::= { vmEntry 11 }
vmMemUnit OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The multiplication unit in bytes for vmCurMem, vmMinMem,
and vmMaxMem. For example, when this value is 1024, the
memory size unit for vmCurMem, vmMinMem, and vmMaxMem is
KiB."
::= { vmEntry 12 }
vmCurMem OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current memory size currently allocated to the
virtual memory module in the unit designated by
<span class="grey">Asai, et al. Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
vmMemUnit."
::= { vmEntry 13 }
vmMinMem OBJECT-TYPE
SYNTAX Integer32 (-1|0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The minimum memory size defined to the virtual machine
in the unit designated by vmMemUnit. The value -1
indicates that there is no hard boundary for the minimum
memory size."
::= { vmEntry 14 }
vmMaxMem OBJECT-TYPE
SYNTAX Integer32 (-1|0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The maximum memory size defined to the virtual machine
in the unit designated by vmMemUnit. The value -1
indicates that there is no limit."
::= { vmEntry 15 }
vmUpTime OBJECT-TYPE
SYNTAX TimeTicks
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The time (in centiseconds) since the administrative
state of the virtual machine was last changed from
shutdown(4) to running(1)."
::= { vmEntry 16 }
vmCpuTime OBJECT-TYPE
SYNTAX Counter64
UNITS "microsecond"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total CPU time used in microseconds. If the number
of virtual CPUs is larger than 1, vmCpuTime may exceed
real time.
Discontinuities in the value of this counter can occur
at re-initialization of the hypervisor and
administrative state (vmAdminState) changes of the
<span class="grey">Asai, et al. Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
virtual machine."
::= { vmEntry 17 }
-- The virtual CPU on each virtual machines
vmCpuTable OBJECT-TYPE
SYNTAX SEQUENCE OF VmCpuEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table of virtual CPUs provided by the hypervisor."
::= { vmObjects 5 }
vmCpuEntry OBJECT-TYPE
SYNTAX VmCpuEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry for one virtual processor assigned to a
virtual machine."
INDEX { vmIndex, vmCpuIndex }
::= { vmCpuTable 1 }
VmCpuEntry ::=
SEQUENCE {
vmCpuIndex VirtualMachineCpuIndex,
vmCpuCoreTime Counter64
}
vmCpuIndex OBJECT-TYPE
SYNTAX VirtualMachineCpuIndex
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique value identifying a virtual CPU assigned to
the virtual machine."
::= { vmCpuEntry 1 }
vmCpuCoreTime OBJECT-TYPE
SYNTAX Counter64
UNITS "microsecond"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total CPU time used by this virtual CPU in
microseconds.
Discontinuities in the value of this counter can occur
at re-initialization of the hypervisor and
<span class="grey">Asai, et al. Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
administrative state (vmAdminState) changes of the
virtual machine."
::= { vmCpuEntry 2 }
-- The virtual CPU affinity on each virtual machines
vmCpuAffinityTable OBJECT-TYPE
SYNTAX SEQUENCE OF VmCpuAffinityEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A list of CPU affinity entries of a virtual CPU."
::= { vmObjects 6 }
vmCpuAffinityEntry OBJECT-TYPE
SYNTAX VmCpuAffinityEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry containing CPU affinity associated with a
particular virtual machine."
INDEX { vmIndex, vmCpuIndex, vmCpuPhysIndex }
::= { vmCpuAffinityTable 1 }
VmCpuAffinityEntry ::=
SEQUENCE {
vmCpuPhysIndex Integer32,
vmCpuAffinity INTEGER
}
vmCpuPhysIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A value identifying a physical CPU on the hypervisor.
On systems implementing the HOST-RESOURCES-MIB, the
value MUST be the same value that is used as the index
in the hrProcessorTable (hrDeviceIndex)."
::= { vmCpuAffinityEntry 2 }
vmCpuAffinity OBJECT-TYPE
SYNTAX INTEGER {
unknown(0), -- unknown
enable(1), -- enabled
disable(2) -- disabled
}
MAX-ACCESS read-only
<span class="grey">Asai, et al. Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
STATUS current
DESCRIPTION
"The CPU affinity of this virtual CPU to the physical
CPU represented by 'vmCpuPhysIndex'."
::= { vmCpuAffinityEntry 3 }
-- The virtual storage devices on each virtual machine. This
-- document defines some overlapped objects with hrStorage in
-- HOST-RESOURCES-MIB (<a href="./rfc2790">RFC 2790</a>), because virtual resources are
-- allocated from the hypervisor's resources, which is the 'host
-- resources'.
vmStorageTable OBJECT-TYPE
SYNTAX SEQUENCE OF VmStorageEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The conceptual table of virtual storage devices
attached to the virtual machine."
::= { vmObjects 7 }
vmStorageEntry OBJECT-TYPE
SYNTAX VmStorageEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry for one virtual storage device attached to the
virtual machine."
INDEX { vmStorageVmIndex, vmStorageIndex }
::= { vmStorageTable 1 }
VmStorageEntry ::=
SEQUENCE {
vmStorageVmIndex VirtualMachineIndexOrZero,
vmStorageIndex VirtualMachineStorageIndex,
vmStorageParent Integer32,
vmStorageSourceType VirtualMachineStorageSourceType,
vmStorageSourceTypeString
SnmpAdminString,
vmStorageResourceID SnmpAdminString,
vmStorageAccess VirtualMachineStorageAccess,
vmStorageMediaType IANAStorageMediaType,
vmStorageMediaTypeString
SnmpAdminString,
vmStorageSizeUnit Integer32,
vmStorageDefinedSize Integer32,
vmStorageAllocatedSize Integer32,
vmStorageReadIOs Counter64,
vmStorageWriteIOs Counter64,
<span class="grey">Asai, et al. Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
vmStorageReadOctets Counter64,
vmStorageWriteOctets Counter64,
vmStorageReadLatency Counter64,
vmStorageWriteLatency Counter64
}
vmStorageVmIndex OBJECT-TYPE
SYNTAX VirtualMachineIndexOrZero
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This value identifies the virtual machine (guest) this
storage device has been allocated to. The value zero
indicates that the storage device is currently not
allocated to any virtual machines."
::= { vmStorageEntry 1 }
vmStorageIndex OBJECT-TYPE
SYNTAX VirtualMachineStorageIndex
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique value identifying a virtual storage device
allocated to the virtual machine."
::= { vmStorageEntry 2 }
vmStorageParent OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of hrStorageIndex, which is the parent (i.e.,
physical) device of this virtual device on systems
implementing the HOST-RESOURCES-MIB. The value zero
denotes this virtual device is not any child
represented in the hrStorageTable."
::= { vmStorageEntry 3 }
vmStorageSourceType OBJECT-TYPE
SYNTAX VirtualMachineStorageSourceType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The source type of the virtual storage device."
::= { vmStorageEntry 4 }
vmStorageSourceTypeString OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
<span class="grey">Asai, et al. Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A (detailed) textual string of the source type of the
virtual storage device. For example, this represents
the specific format name of the sparse file."
::= { vmStorageEntry 5 }
vmStorageResourceID OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A textual string that represents the resource
identifier of the virtual storage. For example, this
contains the path to the disk image file that
corresponds to the virtual storage."
::= { vmStorageEntry 6 }
vmStorageAccess OBJECT-TYPE
SYNTAX VirtualMachineStorageAccess
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The access permission of the virtual storage device."
::= { vmStorageEntry 7 }
vmStorageMediaType OBJECT-TYPE
SYNTAX IANAStorageMediaType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The media type of the virtual storage device."
::= { vmStorageEntry 8 }
vmStorageMediaTypeString OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A (detailed) textual string of the virtual storage
media. For example, this represents the specific driver
name of the emulated media such as 'IDE' and 'SCSI'."
::= { vmStorageEntry 9 }
vmStorageSizeUnit OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-only
<span class="grey">Asai, et al. Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
STATUS current
DESCRIPTION
"The multiplication unit in bytes for
vmStorageDefinedSize and vmStorageAllocatedSize. For
example, when this value is 1048576, the storage size
unit for vmStorageDefinedSize and vmStorageAllocatedSize
is MiB."
::= { vmStorageEntry 10 }
vmStorageDefinedSize OBJECT-TYPE
SYNTAX Integer32 (-1|0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The defined virtual storage size defined in the unit
designated by vmStorageSizeUnit. If this information is
not available, this value MUST be -1."
::= { vmStorageEntry 11 }
vmStorageAllocatedSize OBJECT-TYPE
SYNTAX Integer32 (-1|0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The storage size allocated to the virtual storage from
a physical storage in the unit designated by
vmStorageSizeUnit. When the virtual storage is block
device or raw file, this value and vmStorageDefinedSize
are supposed to equal. This value MUST NOT be different
from vmStorageDefinedSize when vmStorageSourceType is
'block' or 'raw'. If this information is not available,
this value MUST be -1."
::= { vmStorageEntry 12 }
vmStorageReadIOs OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of read I/O requests.
Discontinuities in the value of this counter can occur
at re-initialization of the hypervisor and
administrative state (vmAdminState) changes of the
virtual machine."
::= { vmStorageEntry 13 }
vmStorageWriteIOs OBJECT-TYPE
<span class="grey">Asai, et al. Standards Track [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of write I/O requests.
Discontinuities in the value of this counter can occur
at re-initialization of the hypervisor and
administrative state (vmAdminState) changes of the
virtual machine."
::= { vmStorageEntry 14 }
vmStorageReadOctets OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of bytes read from this device.
Discontinuities in the value of this counter can occur
at re-initialization of the hypervisor and
administrative state (vmAdminState) changes of the
virtual machine."
::= { vmStorageEntry 15 }
vmStorageWriteOctets OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of bytes written to this device.
Discontinuities in the value of this counter can occur
at re-initialization of the hypervisor and
administrative state (vmAdminState) changes of the
virtual machine."
::= { vmStorageEntry 16 }
vmStorageReadLatency OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of microseconds read requests have
been queued for this device.
This would typically be implemented by storing the high
precision system timestamp of when the request is
<span class="grey">Asai, et al. Standards Track [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
received from the virtual machine with the request, the
difference between this initial timestamp and the time
at which the requested operation has completed SHOULD be
converted to microseconds and accumulated.
Discontinuities in the value of this counter can occur at
re-initialization of the hypervisor and administrative
state (vmAdminState) changes of the virtual machine."
::= { vmStorageEntry 17 }
vmStorageWriteLatency OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of microseconds write requests have
been queued for this device.
This would typically be implemented by storing the high
precision system timestamp of when the request is
received from the virtual machine with the request; the
difference between this initial timestamp and the time
at which the requested operation has completed SHOULD be
converted to microseconds and accumulated.
Discontinuities in the value of this counter can occur
at re-initialization of the hypervisor and
administrative state (vmAdminState) changes of the
virtual machine."
::= { vmStorageEntry 18 }
-- The virtual network interfaces on each virtual machine.
vmNetworkTable OBJECT-TYPE
SYNTAX SEQUENCE OF VmNetworkEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The conceptual table of virtual network interfaces
attached to the virtual machine."
::= { vmObjects 8 }
vmNetworkEntry OBJECT-TYPE
SYNTAX VmNetworkEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry for one virtual network interface attached to
<span class="grey">Asai, et al. Standards Track [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
the virtual machine."
INDEX { vmIndex, vmNetworkIndex }
::= { vmNetworkTable 1 }
VmNetworkEntry ::=
SEQUENCE {
vmNetworkIndex VirtualMachineNetworkIndex,
vmNetworkIfIndex InterfaceIndexOrZero,
vmNetworkParent InterfaceIndexOrZero,
vmNetworkModel SnmpAdminString,
vmNetworkPhysAddress PhysAddress
}
vmNetworkIndex OBJECT-TYPE
SYNTAX VirtualMachineNetworkIndex
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique value identifying a virtual network interface
allocated to the virtual machine."
::= { vmNetworkEntry 1 }
vmNetworkIfIndex OBJECT-TYPE
SYNTAX InterfaceIndexOrZero
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of ifIndex, which corresponds to this virtual
network interface. If this device is not represented in
the ifTable, then this value MUST be zero."
::= { vmNetworkEntry 2 }
vmNetworkParent OBJECT-TYPE
SYNTAX InterfaceIndexOrZero
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of ifIndex, which corresponds to the parent
(i.e., physical) device of this virtual device. The
value zero denotes this virtual device is not any
child represented in the ifTable."
::= { vmNetworkEntry 3 }
vmNetworkModel OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
<span class="grey">Asai, et al. Standards Track [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
"A textual string containing the (emulated) model of the
virtual network interface. For example, this value is
'virtio' when the emulation driver model is virtio."
::= { vmNetworkEntry 4 }
vmNetworkPhysAddress OBJECT-TYPE
SYNTAX PhysAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Media Access Control (MAC) address of the virtual
network interface."
::= { vmNetworkEntry 5 }
-- Notification definitions:
vmPerVMNotificationsEnabled OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicates if the notification generator will send
notifications per virtual machine. Changes to this
object MUST NOT persist across re-initialization of
the management system, e.g., SNMP agent."
::= { vmObjects 9 }
vmBulkNotificationsEnabled OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicates if the notification generator will send
notifications per set of virtual machines. Changes to
this object MUST NOT persist across re-initialization of
the management system, e.g., SNMP agent."
::= { vmObjects 10 }
vmAffectedVMs OBJECT-TYPE
SYNTAX VirtualMachineList
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"A complete list of virtual machines whose state has
changed. This object is the only object sent with bulk
notifications."
::= { vmObjects 11 }
<span class="grey">Asai, et al. Standards Track [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
vmRunning NOTIFICATION-TYPE
OBJECTS {
vmName,
vmUUID,
vmOperState
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of a virtual machine has been changed to
running(4) from some other state. The other state is
indicated by the included value of vmOperState."
::= { vmNotifications 1 }
vmShuttingdown NOTIFICATION-TYPE
OBJECTS {
vmName,
vmUUID,
vmOperState
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of a virtual machine has been changed to
shuttingdown(10) from some other state. The other state
is indicated by the included value of vmOperState."
::= { vmNotifications 2 }
vmShutdown NOTIFICATION-TYPE
OBJECTS {
vmName,
vmUUID,
vmOperState
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of a virtual machine has been changed to
shutdown(11) from some other state. The other state is
indicated by the included value of vmOperState."
::= { vmNotifications 3 }
vmPaused NOTIFICATION-TYPE
OBJECTS {
vmName,
vmUUID,
vmOperState
}
<span class="grey">Asai, et al. Standards Track [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of a virtual machine has been changed to
paused(8) from some other state. The other state is
indicated by the included value of vmOperState."
::= { vmNotifications 4 }
vmSuspending NOTIFICATION-TYPE
OBJECTS {
vmName,
vmUUID,
vmOperState
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of a virtual machine has been changed to
suspending(5) from some other state. The other state is
indicated by the included value of vmOperState."
::= { vmNotifications 5 }
vmSuspended NOTIFICATION-TYPE
OBJECTS {
vmName,
vmUUID,
vmOperState
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of a virtual machine has been changed to
suspended(6) from some other state. The other state is
indicated by the included value of vmOperState."
::= { vmNotifications 6 }
vmResuming NOTIFICATION-TYPE
OBJECTS {
vmName,
vmUUID,
vmOperState
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of a virtual machine has been changed to
resuming(7) from some other state. The other state is
indicated by the included value of vmOperState."
<span class="grey">Asai, et al. Standards Track [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
::= { vmNotifications 7 }
vmMigrating NOTIFICATION-TYPE
OBJECTS {
vmName,
vmUUID,
vmOperState
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of a virtual machine has been changed to
migrating(9) from some other state. The other state is
indicated by the included value of vmOperState."
::= { vmNotifications 8 }
vmCrashed NOTIFICATION-TYPE
OBJECTS {
vmName,
vmUUID,
vmOperState
}
STATUS current
DESCRIPTION
"This notification is generated when a virtual machine
has been crashed. The previous state of the virtual
machine is indicated by the included value of
vmOperState."
::= { vmNotifications 9 }
vmDeleted NOTIFICATION-TYPE
OBJECTS {
vmName,
vmUUID,
vmOperState,
vmPersistent
}
STATUS current
DESCRIPTION
"This notification is generated when a virtual machine
has been deleted. The prior state of the virtual
machine is indicated by the included value of
vmOperState."
::= { vmNotifications 10 }
vmBulkRunning NOTIFICATION-TYPE
OBJECTS {
vmAffectedVMs
<span class="grey">Asai, et al. Standards Track [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of one or more virtual machines has been changed
to running(4) from any prior state, except for
running(4). Management stations are encouraged to
subsequently poll the subset of virtual machines of
interest for vmOperState."
::= { vmNotifications 11 }
vmBulkShuttingdown NOTIFICATION-TYPE
OBJECTS {
vmAffectedVMs
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of one or more virtual machines has been changed
to shuttingdown(10) from a state other than
shuttingdown(10). Management stations are encouraged to
subsequently poll the subset of virtual machines of
interest for vmOperState."
::= { vmNotifications 12 }
vmBulkShutdown NOTIFICATION-TYPE
OBJECTS {
vmAffectedVMs
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of one or more virtual machine has been changed to
shutdown(11) from a state other than shutdown(11).
Management stations are encouraged to subsequently poll
the subset of virtual machines of interest for
vmOperState."
::= { vmNotifications 13 }
vmBulkPaused NOTIFICATION-TYPE
OBJECTS {
vmAffectedVMs
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of one or more virtual machines has been changed
to paused(8) from a state other than paused(8).
<span class="grey">Asai, et al. Standards Track [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
Management stations are encouraged to subsequently poll
the subset of virtual machines of interest for
vmOperState."
::= { vmNotifications 14 }
vmBulkSuspending NOTIFICATION-TYPE
OBJECTS {
vmAffectedVMs
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of one or more virtual machines has been changed
to suspending(5) from a state other than suspending(5).
Management stations are encouraged to subsequently poll
the subset of virtual machines of interest for
vmOperState."
::= { vmNotifications 15 }
vmBulkSuspended NOTIFICATION-TYPE
OBJECTS {
vmAffectedVMs
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of one or more virtual machines has been changed
to suspended(6) from a state other than suspended(6).
Management stations are encouraged to subsequently poll
the subset of virtual machines of interest for
vmOperState."
::= { vmNotifications 16 }
vmBulkResuming NOTIFICATION-TYPE
OBJECTS {
vmAffectedVMs
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of one or more virtual machines has been changed
to resuming(7) from a state other than resuming(7).
Management stations are encouraged to subsequently poll
the subset of virtual machines of interest for
vmOperState."
::= { vmNotifications 17 }
vmBulkMigrating NOTIFICATION-TYPE
<span class="grey">Asai, et al. Standards Track [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
OBJECTS {
vmAffectedVMs
}
STATUS current
DESCRIPTION
"This notification is generated when the operational
state of one or more virtual machines has been changed
to migrating(9) from a state other than migrating(9).
Management stations are encouraged to subsequently poll
the subset of virtual machines of interest for
vmOperState."
::= { vmNotifications 18 }
vmBulkCrashed NOTIFICATION-TYPE
OBJECTS {
vmAffectedVMs
}
STATUS current
DESCRIPTION
"This notification is generated when one or more virtual
machines have been crashed. Management stations are
encouraged to subsequently poll the subset of virtual
machines of interest for vmOperState."
::= { vmNotifications 19 }
vmBulkDeleted NOTIFICATION-TYPE
OBJECTS {
vmAffectedVMs
}
STATUS current
DESCRIPTION
"This notification is generated when one or more virtual
machines have been deleted. Management stations are
encouraged to subsequently poll the subset of virtual
machines of interest for vmOperState."
::= { vmNotifications 20 }
-- Compliance definitions:
vmCompliances OBJECT IDENTIFIER ::= { vmConformance 1 }
vmGroups OBJECT IDENTIFIER ::= { vmConformance 2 }
vmFullCompliances MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"Compliance statement for implementations supporting
read/write access, according to the object definitions."
MODULE -- this module
MANDATORY-GROUPS {
<span class="grey">Asai, et al. Standards Track [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
vmHypervisorGroup,
vmVirtualMachineGroup,
vmCpuGroup,
vmCpuAffinityGroup,
vmStorageGroup,
vmNetworkGroup
}
GROUP vmPerVMNotificationOptionalGroup
DESCRIPTION
"Support for per-VM notifications is optional. If not
implemented, then vmPerVMNotificationsEnabled MUST report
false(2)."
GROUP vmBulkNotificationsVariablesGroup
DESCRIPTION
"Necessary only if vmPerVMNotificationOptionalGroup is
implemented."
GROUP vmBulkNotificationOptionalGroup
DESCRIPTION
"Support for bulk notifications is optional. If not
implemented, then vmBulkNotificationsEnabled MUST report
false(2)."
::= { vmCompliances 1 }
vmReadOnlyCompliances MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"Compliance statement for implementations supporting
only read-only access."
MODULE -- this module
MANDATORY-GROUPS {
vmHypervisorGroup,
vmVirtualMachineGroup,
vmCpuGroup,
vmCpuAffinityGroup,
vmStorageGroup,
vmNetworkGroup
}
OBJECT vmPerVMNotificationsEnabled
MIN-ACCESS read-only
DESCRIPTION
"Write access is not required."
OBJECT vmBulkNotificationsEnabled
MIN-ACCESS read-only
DESCRIPTION
"Write access is not required."
<span class="grey">Asai, et al. Standards Track [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
::= { vmCompliances 2 }
vmHypervisorGroup OBJECT-GROUP
OBJECTS {
vmHvSoftware,
vmHvVersion,
vmHvObjectID,
vmHvUpTime,
vmNumber,
vmTableLastChange,
vmPerVMNotificationsEnabled,
vmBulkNotificationsEnabled
}
STATUS current
DESCRIPTION
"A collection of objects providing insight into the
hypervisor itself."
::= { vmGroups 1 }
vmVirtualMachineGroup OBJECT-GROUP
OBJECTS {
-- vmIndex
vmName,
vmUUID,
vmOSType,
vmAdminState,
vmOperState,
vmAutoStart,
vmPersistent,
vmCurCpuNumber,
vmMinCpuNumber,
vmMaxCpuNumber,
vmMemUnit,
vmCurMem,
vmMinMem,
vmMaxMem,
vmUpTime,
vmCpuTime
}
STATUS current
DESCRIPTION
"A collection of objects providing insight into the
virtual machines controlled by a hypervisor."
::= { vmGroups 2 }
vmCpuGroup OBJECT-GROUP
OBJECTS {
-- vmCpuIndex,
<span class="grey">Asai, et al. Standards Track [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
vmCpuCoreTime
}
STATUS current
DESCRIPTION
"A collection of objects providing insight into the
virtual machines controlled by a hypervisor."
::= { vmGroups 3 }
vmCpuAffinityGroup OBJECT-GROUP
OBJECTS {
-- vmCpuPhysIndex,
vmCpuAffinity
}
STATUS current
DESCRIPTION
"A collection of objects providing insight into the
virtual machines controlled by a hypervisor."
::= { vmGroups 4 }
vmStorageGroup OBJECT-GROUP
OBJECTS {
-- vmStorageVmIndex,
-- vmStorageIndex,
vmStorageParent,
vmStorageSourceType,
vmStorageSourceTypeString,
vmStorageResourceID,
vmStorageAccess,
vmStorageMediaType,
vmStorageMediaTypeString,
vmStorageSizeUnit,
vmStorageDefinedSize,
vmStorageAllocatedSize,
vmStorageReadIOs,
vmStorageWriteIOs,
vmStorageReadOctets,
vmStorageWriteOctets,
vmStorageReadLatency,
vmStorageWriteLatency
}
STATUS current
DESCRIPTION
"A collection of objects providing insight into the
virtual storage devices controlled by a hypervisor."
::= { vmGroups 5 }
vmNetworkGroup OBJECT-GROUP
OBJECTS {
<span class="grey">Asai, et al. Standards Track [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
-- vmNetworkIndex,
vmNetworkIfIndex,
vmNetworkParent,
vmNetworkModel,
vmNetworkPhysAddress
}
STATUS current
DESCRIPTION
"A collection of objects providing insight into the
virtual network interfaces controlled by a hypervisor."
::= { vmGroups 6 }
vmPerVMNotificationOptionalGroup NOTIFICATION-GROUP
NOTIFICATIONS {
vmRunning,
vmShuttingdown,
vmShutdown,
vmPaused,
vmSuspending,
vmSuspended,
vmResuming,
vmMigrating,
vmCrashed,
vmDeleted
}
STATUS current
DESCRIPTION
"A collection of notifications for per-VM notification
of changes to virtual machine state (vmOperState) as
reported by a hypervisor."
::= { vmGroups 7 }
vmBulkNotificationsVariablesGroup OBJECT-GROUP
OBJECTS {
vmAffectedVMs
}
STATUS current
DESCRIPTION
"The variables used in vmBulkNotificationOptionalGroup
virtual network interfaces controlled by a hypervisor."
::= { vmGroups 8 }
vmBulkNotificationOptionalGroup NOTIFICATION-GROUP
NOTIFICATIONS {
vmBulkRunning,
vmBulkShuttingdown,
vmBulkShutdown,
vmBulkPaused,
<span class="grey">Asai, et al. Standards Track [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
vmBulkSuspending,
vmBulkSuspended,
vmBulkResuming,
vmBulkMigrating,
vmBulkCrashed,
vmBulkDeleted
}
STATUS current
DESCRIPTION
"A collection of notifications for bulk notification of
changes to virtual machine state (vmOperState) as
reported by a given hypervisor."
::= { vmGroups 9 }
END
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. IANA-STORAGE-MEDIA-TYPE-MIB</span>
IANA-STORAGE-MEDIA-TYPE-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, mib-2
FROM SNMPv2-SMI
TEXTUAL-CONVENTION
FROM SNMPv2-TC;
ianaStorageMediaTypeMIB MODULE-IDENTITY
LAST-UPDATED "201510120000Z" -- 12 October 2015
ORGANIZATION "IANA"
CONTACT-INFO
"Internet Assigned Numbers Authority
Postal: ICANN
12025 Waterfront Drive, Suite 300
Los Angeles, CA 90094-2536
United States
Tel: +1 310-301-5800
Email: iana@iana.org"
DESCRIPTION
"This MIB module defines Textual Conventions
representing the media type of a storage device.
Copyright (c) 2015 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the
<span class="grey">Asai, et al. Standards Track [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
Simplified BSD License set forth in <a href="#section-4">Section 4</a>.c of 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>)."
REVISION "201510120000Z" -- 12 October 2015
DESCRIPTION
"The initial version of this MIB, published as
<a href="./rfc7666">RFC 7666</a>."
::= { mib-2 237 }
IANAStorageMediaType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The media type of a storage device:
unknown(1) The media type is unknown, e.g., because
the implementation failed to obtain the
media type from the hypervisor.
other(2) The media type is other than those
defined in this conversion.
hardDisk(3) The media type is hard disk.
opticalDisk(4) The media type is optical disk.
floppyDisk(5) The media type is floppy disk."
SYNTAX INTEGER {
other(1),
unknown(2),
hardDisk(3),
opticalDisk(4),
floppyDisk(5)
}
END
<span class="grey">Asai, et al. Standards Track [Page 44]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. IANA Considerations</span>
This document defines the first version of the IANA-maintained
IANA-STORAGE-MEDIA-TYPE-MIB module, which allows new storage media
types to be added to the enumeration in IANAStorageMediaType. An
Expert Review, as defined in <a href="./rfc5226">RFC 5226</a> [<a href="./rfc5226" title="">RFC5226</a>], is REQUIRED for each
modification.
The MIB module in this document uses the following IANA-assigned
OBJECT IDENTIFIER values recorded in the SMI Numbers registry:
Descriptor OBJECT IDENTIFIER value
---------- -----------------------
vmMIB { mib-2 236 }
ianaStorageMediaTypeMIB { mib-2 237 }
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Security Considerations</span>
This MIB module is typically implemented on the hypervisor not inside
a virtual machine. Virtual machines, possibly under other
administrative domains, would not have access to this MIB as the SNMP
service would typically operate in a separate management network.
There are two objects defined in this MIB module,
vmPerVMNotificationsEnabled and vmBulkNotificationsEnabled, that have
a MAX-ACCESS clause of read-write. Enabling notifications can lead
to a substantial number of notifications if many virtual machines
change their state concurrently. Hence, such objects may be
considered sensitive or vulnerable in some network environments. The
support for SET operations in a non-secure environment without proper
protection can have a negative effect on the management system. It
is RECOMMENDED that these objects have access of read-only instead of
read-write on deployments where SNMPv3 strong security (i.e.,
authentication and encryption) is not used.
There are a number of managed objects in this MIB that may contain
sensitive information. The objects in the vmHvSoftware and
vmHvVersion list information about the hypervisor's software and
version. Some may wish not to disclose to others which software they
are running. Further, an inventory of the running software and
versions may be helpful to an attacker who hopes to exploit software
bugs in certain applications. Moreover, the objects in the vmTable,
vmCpuTable, vmCpuAffinityTable, vmStorageTable, and
vmNetworkTable list information about the virtual machines and their
virtual resource allocation. Some may wish not to disclose to others
how many and what virtual machines they are operating.
<span class="grey">Asai, et al. Standards Track [Page 45]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
It is thus important to control even GET access to these objects and
possibly to even encrypt the values of these objects when sending
them over the network via SNMP. Not all versions of SNMP provide
features for such a secure environment.
SNMPv1 by itself is not a secure environment. Even if the network
itself is secure (for example by using IPsec), there is no control as
to who on the secure network is allowed to access and GET/SET
(read/change/create/delete) the objects in this MIB module.
It is recommended that the implementers consider using the security
features as provided by the SNMPv3 framework. Specifically, the use
of the User-based Security Model [<a href="./rfc3414" title=""User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)"">RFC3414</a>] and the View-based Access
Control Model [<a href="./rfc3415" title=""View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)"">RFC3415</a>] is recommended.
It is then a customer/user responsibility to ensure that the SNMP
entity giving access to an instance of this MIB is properly
configured to give access to the objects only to those principals
(users) that have legitimate rights to indeed GET or SET
(change/create/delete) them.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. References</span>
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.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="http://www.rfc-editor.org/info/rfc2119">http://www.rfc-editor.org/info/rfc2119</a>>.
[<a id="ref-RFC2578">RFC2578</a>] McCloghrie, K., Ed., Perkins, D., Ed., and J.
Schoenwaelder, Ed., "Structure of Management Information
Version 2 (SMIv2)", STD 58, <a href="./rfc2578">RFC 2578</a>,
DOI 10.17487/RFC2578, April 1999,
<<a href="http://www.rfc-editor.org/info/rfc2578">http://www.rfc-editor.org/info/rfc2578</a>>.
[<a id="ref-RFC2579">RFC2579</a>] McCloghrie, K., Ed., Perkins, D., Ed., and J.
Schoenwaelder, Ed., "Textual Conventions for SMIv2",
STD 58, <a href="./rfc2579">RFC 2579</a>, DOI 10.17487/RFC2579, April 1999,
<<a href="http://www.rfc-editor.org/info/rfc2579">http://www.rfc-editor.org/info/rfc2579</a>>.
[<a id="ref-RFC2580">RFC2580</a>] McCloghrie, K., Ed., Perkins, D., Ed., and J.
Schoenwaelder, Ed., "Conformance Statements for SMIv2",
STD 58, <a href="./rfc2580">RFC 2580</a>, DOI 10.17487/RFC2580, April 1999,
<<a href="http://www.rfc-editor.org/info/rfc2580">http://www.rfc-editor.org/info/rfc2580</a>>.
<span class="grey">Asai, et al. Standards Track [Page 46]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
[<a id="ref-RFC2790">RFC2790</a>] Waldbusser, S. and P. Grillo, "Host Resources MIB",
<a href="./rfc2790">RFC 2790</a>, DOI 10.17487/RFC2790, March 2000,
<<a href="http://www.rfc-editor.org/info/rfc2790">http://www.rfc-editor.org/info/rfc2790</a>>.
[<a id="ref-RFC2863">RFC2863</a>] McCloghrie, K. and F. Kastenholz, "The Interfaces Group
MIB", <a href="./rfc2863">RFC 2863</a>, DOI 10.17487/RFC2863, June 2000,
<<a href="http://www.rfc-editor.org/info/rfc2863">http://www.rfc-editor.org/info/rfc2863</a>>.
[<a id="ref-RFC3413">RFC3413</a>] Levi, D., Meyer, P., and B. Stewart, "Simple Network
Management Protocol (SNMP) Applications", STD 62,
<a href="./rfc3413">RFC 3413</a>, DOI 10.17487/RFC3413, December 2002,
<<a href="http://www.rfc-editor.org/info/rfc3413">http://www.rfc-editor.org/info/rfc3413</a>>.
[<a id="ref-RFC3414">RFC3414</a>] Blumenthal, U. and B. Wijnen, "User-based Security Model
(USM) for version 3 of the Simple Network Management
Protocol (SNMPv3)", STD 62, <a href="./rfc3414">RFC 3414</a>,
DOI 10.17487/RFC3414, December 2002,
<<a href="http://www.rfc-editor.org/info/rfc3414">http://www.rfc-editor.org/info/rfc3414</a>>.
[<a id="ref-RFC3415">RFC3415</a>] Wijnen, B., Presuhn, R., and K. McCloghrie, "View-based
Access Control Model (VACM) for the Simple Network
Management Protocol (SNMP)", STD 62, <a href="./rfc3415">RFC 3415</a>,
DOI 10.17487/RFC3415, December 2002,
<<a href="http://www.rfc-editor.org/info/rfc3415">http://www.rfc-editor.org/info/rfc3415</a>>.
[<a id="ref-RFC3418">RFC3418</a>] Presuhn, R., Ed., "Management Information Base (MIB) for
the Simple Network Management Protocol (SNMP)", STD 62,
<a href="./rfc3418">RFC 3418</a>, DOI 10.17487/RFC3418, December 2002,
<<a href="http://www.rfc-editor.org/info/rfc3418">http://www.rfc-editor.org/info/rfc3418</a>>.
[<a id="ref-RFC5226">RFC5226</a>] Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc5226">RFC 5226</a>,
DOI 10.17487/RFC5226, May 2008,
<<a href="http://www.rfc-editor.org/info/rfc5226">http://www.rfc-editor.org/info/rfc5226</a>>.
[<a id="ref-RFC6933">RFC6933</a>] Bierman, A., Romascanu, D., Quittek, J., and M.
Chandramouli, "Entity MIB (Version 4)", <a href="./rfc6933">RFC 6933</a>,
DOI 10.17487/RFC6933, May 2013,
<<a href="http://www.rfc-editor.org/info/rfc6933">http://www.rfc-editor.org/info/rfc6933</a>>.
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. Informative References</span>
[<a id="ref-IEEE8021-BRIDGE-MIB">IEEE8021-BRIDGE-MIB</a>]
IEEE, "IEEE8021-BRIDGE-MIB", October 2008,
<<a href="http://www.ieee802.org/1/files/public/MIBs/IEEE8021-BRIDGE-MIB-200810150000Z.txt">http://www.ieee802.org/1/files/public/MIBs/</a>
<a href="http://www.ieee802.org/1/files/public/MIBs/IEEE8021-BRIDGE-MIB-200810150000Z.txt">IEEE8021-BRIDGE-MIB-200810150000Z.txt</a>>.
<span class="grey">Asai, et al. Standards Track [Page 47]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
[<a id="ref-IEEE8021-Q-BRIDGE-MIB">IEEE8021-Q-BRIDGE-MIB</a>]
IEEE, "IEEE8021-Q-BRIDGE-MIB", October 2008,
<<a href="http://www.ieee802.org/1/files/public/MIBs/IEEE8021-Q-BRIDGE-MIB-200810150000Z.txt">http://www.ieee802.org/1/files/public/MIBs/</a>
<a href="http://www.ieee802.org/1/files/public/MIBs/IEEE8021-Q-BRIDGE-MIB-200810150000Z.txt">IEEE8021-Q-BRIDGE-MIB-200810150000Z.txt</a>>.
[<a id="ref-libvirt">libvirt</a>] The libvirt developers, "The libvirt virtialization API",
<<a href="http://www.libvirt.org/">http://www.libvirt.org/</a>>.
[<a id="ref-RFC3410">RFC3410</a>] Case, J., Mundy, R., Partain, D., and B. Stewart,
"Introduction and Applicability Statements for Internet-
Standard Management Framework", <a href="./rfc3410">RFC 3410</a>,
DOI 10.17487/RFC3410, December 2002,
<<a href="http://www.rfc-editor.org/info/rfc3410">http://www.rfc-editor.org/info/rfc3410</a>>.
[<a id="ref-VMware">VMware</a>] VMware, Inc., "The VMware Hypervisor",
<<a href="http://www.vmware.com/">http://www.vmware.com/</a>>.
[<a id="ref-Xen">Xen</a>] The Xen Project, "The Xen Hypervisor",
<<a href="http://www.xenproject.org/">http://www.xenproject.org/</a>>.
<span class="grey">Asai, et al. Standards Track [Page 48]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. State Transition Table</span>
+--------------+----------------+--------------+--------------------+
| State | Change to | Next State | Notification |
| | vmAdminState | | |
| | at the | | |
| | hypervisor or | | |
| | (Event) | | |
+--------------+----------------+--------------+--------------------+
| suspended | running | resuming | vmResuming | |
| | | | vmBulkResuming |
| | | | |
| suspending | (suspend | suspended | vmSuspended | |
| | operation | | vmBulkSuspended |
| | completed) | | |
| | | | |
| running | suspended | suspending | vmSuspending | |
| | | | vmBulkSuspending |
| | | | |
| | shutdown | shuttingdown | vmShuttingdown | |
| | | | vmBulkShuttingdown |
| | | | |
| | (migration to | migrating | vmMigrating | |
| | other | | vmBulkMigrating |
| | hypervisor | | |
| | initiated) | | |
| | | | |
| resuming | (resume | running | vmRunning | |
| | operation | | vmBulkRunning |
| | completed) | | |
| | | | |
| paused | running | running | vmRunning | |
| | | | vmBulkRunning |
| | | | |
| shuttingdown | (shutdown | shutdown | vmShutdown | |
| | operation | | vmBulkShutdown |
| | completed) | | |
| | | | |
| shutdown | running | running | vmRunning | |
| | | | vmBulkRunning |
| | | | |
| | (if this state | migrating | vmMigrating | |
| | entry is | | vmBulkMigrating |
| | created by a | | |
| | migration | | |
| | operation (*) | | |
| | | | |
<span class="grey">Asai, et al. Standards Track [Page 49]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
| | (deletion | (no state) | vmDeleted | |
| | operation | | vmBulkDeleted |
| | completed) | | |
| | | | |
| migrating | (migration | running | vmRunning | |
| | from other | | vmBulkRunning |
| | hypervisor | | |
| | completed) | | |
| | | | |
| | (migration to | shutdown | vmShutdown | |
| | other | | vmBulkShutdown |
| | hypervisor | | |
| | completed) | | |
| | | | |
| preparing | (preparation | shutdown | vmShutdown | |
| | completed) | | vmBulkShutdown |
| | | | |
| crashed | - | - | - |
| | | | |
| | (crashed) | crashed | vmCrashed | |
| | | | vmBulkCrashed |
| | | | |
| (no state) | (preparation | preparing | - |
| | initiated) | | |
| | | | |
| | (migrate from | shutdown (*) | vmShutdown | |
| | other | | vmBulkShutdown |
| | hypervisor | | |
| | initiated) | | |
+--------------+----------------+--------------+--------------------+
State Transition Table for vmOperState
<span class="grey">Asai, et al. Standards Track [Page 50]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
Acknowledgements
The authors would like to thank Andy Bierman, David Black, Joe Marcus
Clarke, C.M. Heard, Joel Jaeggli, Tom Petch, Randy Presuhn, and Ian
West for providing helpful comments during the development of this
specification.
Juergen Schoenwaelder was partly funded by Flamingo, a Network of
Excellence project (ICT-318488) supported by the European Commission
under its Seventh Framework Programme.
Contributors
Yuji Sekiya
The University of Tokyo
2-11-16 Yayoi
Bunkyo-ku, Tokyo 113-8658
Japan
Email: sekiya@wide.ad.jp
Cathy Zhou
Huawei Technologies
Bantian, Longgang District
Shenzhen 518129
China
Email: cathyzhou@huawei.com
Hiroshi Esaki
The University of Tokyo
7-3-1 Hongo
Bunkyo-ku, Tokyo 113-8656
Japan
Email: hiroshi@wide.ad.jp
<span class="grey">Asai, et al. Standards Track [Page 51]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
<span class="grey"><a href="./rfc7666">RFC 7666</a> Virtual Machine Monitoring MIB October 2015</span>
Authors' Addresses
Hirochika Asai
The University of Tokyo
7-3-1 Hongo
Bunkyo-ku, Tokyo 113-8656
Japan
Phone: +81 3 5841 6748
Email: panda@hongo.wide.ad.jp
Michael MacFaden
VMware Inc.
Email: mrm@vmware.com
Juergen Schoenwaelder
Jacobs University
Campus Ring 1
Bremen 28759
Germany
Email: j.schoenwaelder@jacobs-university.de
Keiichi Shima
IIJ Innovation Institute Inc.
2-10-2 Fujimi
Chiyoda-ku, Tokyo 102-0071
Japan
Email: keiichi@iijlab.net
Tina Tsou
Huawei Technologies (USA)
2330 Central Expressway
Santa Clara, CA 95050
United States
Email: tina.tsou.zouting@huawei.com
Asai, et al. Standards Track [Page 52]
</pre>
|